介面文件的撰寫與生成
方法一:用命令實現(較為麻煩)
1.apiDoc的安裝
注意:在安裝apiDoc之前,需要先安裝Node.js,下載地址:https://nodejs.org/en/download/
- npm install apidoc -g
- 生成api的終端命令：apidoc -i 程式碼所在路徑 -o 生成檔案的路徑
- eg:
- 根據提示,你需要建一個apidos.json
- project的介紹寫在單獨的json檔案中apidoc.json：
{
"name": "project_name"
"version": "0.1.0",
"description": "who am i ,what i can do ",
"title": " title of the html that generated by apiDoc",
"sampleUrl" : "https://127.0.0.1:8000"
}
具體api的書寫模版
"""
@api {methods} url description
@apiName unique_name
@apiGroup group
@apiParam {type} field description
@apiSuccessExample {json} Success-Response:
HTTP/1.1 200 OK
{
"errno":200,
"errmsg":errmsg,
}
@apiError errortype description.
@apiErrorExample {json} Error-Response:
HTTP/1.1 200 OK
{
"errno":401
"errmsg": "UserNotFound"
}
"""
將api的書寫模版粘到django專案的views.py中,再次執行生成api的終端命令
此時去檢視專案結構
重新整理網頁
方法二:非命令式(較為簡單)
1.建立一個新的專案
2.將前兩個檔案複製貼上到專案的根目錄下
3.執行apidoc_init.py
4.執行生成api的終端命令
此時會發現在專案根目錄下會多個apidoctest資料夾
將該資料夾展開,找到index.html,在瀏覽器中開啟後,重新整理頁面即可
