使用apiDoc實現(xiàn)python接口文檔編寫
更新時間：2019年11月19日 15:12:46 作者：Gary5556
今天小編就為大家分享一篇使用apiDoc實現(xiàn)python接口文檔編寫，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧
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實現(xiàn)python接口文檔編寫就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了Python中的字典與成員運算符初步探究,是Python入門學(xué)習(xí)中的基礎(chǔ)知識,需要的朋友可以參考下2015-10-10
這篇文章主要介紹了python Canny邊緣檢測算法的實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-04-04
利用Pandas和Numpy按時間戳將數(shù)據(jù)以Groupby方式分組
這篇文章主要介紹了利用Pandas和Numpy按時間戳將數(shù)據(jù)以Groupby方式分組，文中通過示例代碼介紹的非常詳細，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07
DICOM（Digital Imaging and Communications in Medicine）即醫(yī)學(xué)數(shù)字成像和通信，是醫(yī)學(xué)圖像和相關(guān)信息的國際標(biāo)準(zhǔn)（ISO 12052）。下面這篇文章主要給大家介紹了關(guān)于python對DICOM圖像讀取的相關(guān)資料，需要的朋友可以參考借鑒，下面來一起看看吧。2017-07-07
這篇文章主要介紹了Python實現(xiàn)的文本編輯器功能,結(jié)合實例形式詳細分析了基于wxpython實現(xiàn)文本編輯器所需的功能及相關(guān)實現(xiàn)技巧,需要的朋友可以參考下2017-06-06
python3在同一行內(nèi)輸入n個數(shù)并用列表保存的例子
今天小編就為大家分享一篇python3在同一行內(nèi)輸入n個數(shù)并用列表保存的例子，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-07-07
Windows下將Python文件打包成.EXE可執(zhí)行文件的方法
這篇文章主要介紹了Windows下將Python文件打包成.EXE可執(zhí)行文件的方法,需要的朋友可以參考下2018-08-08
全面了解Python的getattr(),setattr(),delattr(),hasattr()
下面小編就為大家?guī)硪黄媪私釶ython的getattr(),setattr(),delattr(),hasattr()。小編覺得挺不錯的，現(xiàn)在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2016-06-06
這篇文章主要介紹了使用 Python 實現(xiàn)文件遞歸遍歷的三種方式,非常不錯，具有一定的參考借鑒價值，需要的朋友參考下吧2018-07-07
每天上班最痛苦的事情就是早起早起早起！這是大部分上班族的痛苦，但是不上班又是不可能的啦，因為都是為了搞錢。本文用Python制作了三款有趣的鬧鐘，感興趣的可以學(xué)習(xí)一下2022-05-05