使用apiDoc實(shí)現(xiàn)python接口文檔編寫
更新時間：2019年11月19日 15:12:46 作者：Gary5556
今天小編就為大家分享一篇使用apiDoc實(shí)現(xiàn)python接口文檔編寫，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧
apiDoc的安裝
npm install apidoc -g
生成api的終端命令：apidoc -i 代碼所在路徑-o 生成文件的路徑
接口文檔的編寫
文件的簡介
project的介紹寫在單獨(dú)的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實(shí)現(xiàn)python接口文檔編寫就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持腳本之家。
相關(guān)文章
使用Protocol Buffers的C語言拓展提速Python程序的示例
這篇文章主要介紹了使用Protocol Buffers的C語言拓展提速Python程序的示例,使用C拓展Python是Python編程進(jìn)階中的重要技巧,需要的朋友可以參考下2015-04-04
今天小編就為大家分享一篇Python使用Turtle庫繪制一棵西蘭花，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-11-11
python 判斷l(xiāng)inux進(jìn)程,并殺死進(jìn)程的實(shí)現(xiàn)方法
今天小編就為大家分享一篇python 判斷l(xiāng)inux進(jìn)程,并殺死進(jìn)程的實(shí)現(xiàn)方法，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-07-07
將tensorflow的ckpt模型存儲為npy的實(shí)例
今天小編就為大家分享一篇將tensorflow的ckpt模型存儲為npy的實(shí)例，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-07-07
Python將文本去空格并保存到txt文件中的實(shí)例
今天小編就為大家分享一篇Python將文本去空格并保存到txt文件中的實(shí)例，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-07-07
python自然語言編碼轉(zhuǎn)換模塊codecs介紹
這篇文章主要介紹了python自然語言編碼轉(zhuǎn)換模塊codecs介紹,codecs專門用作編碼轉(zhuǎn)換,通過它的接口是可以擴(kuò)展到其他關(guān)于代碼方面的轉(zhuǎn)換,需要的朋友可以參考下2015-04-04
python默認(rèn)參數(shù)調(diào)用方法解析
這篇文章主要介紹了python默認(rèn)參數(shù)調(diào)用方法解析,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-02-02
今天小編就為大家分享一篇Python 互換字典的鍵值對實(shí)例，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2019-02-02
pip已經(jīng)安裝好第三方庫但pycharm中import時還是標(biāo)紅的解決方案
這篇文章主要介紹了python中pip已經(jīng)安裝好第三方庫但pycharm中import時還是標(biāo)紅的問題,本文給大家分享解決方法，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-10-10
對pandas讀取中文unicode的csv和添加行標(biāo)題的方法詳解
今天小編就為大家分享一篇對pandas讀取中文unicode的csv和添加行標(biāo)題的方法詳解，具有很好的參考價(jià)值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-12-12