apiDoc的安裝

npm install apidoc -g

點擊官方文檔

生成api的終端命令：apidoc -i 代碼所在路徑-o 生成文件的路徑

接口文檔的編寫

文件的簡介

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"  }"""

以上這篇使用apiDoc實現python接口文檔編寫就是小編分享給大家的全部內容了，希望能給大家一個參考，也希望大家多多支持武林站長站。