神剑山庄资源网 Design By www.hcban.com
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接口文档编写就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。
神剑山庄资源网 Design By www.hcban.com
神剑山庄资源网
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件!
如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
神剑山庄资源网 Design By www.hcban.com
暂无使用apiDoc实现python接口文档编写的评论...
更新日志
2024年09月30日
2024年09月30日
- 孙悦.1996-伙伴【正大国际】【WAV+CUE】
- 纪钧瀚《钢琴阅读时光 雨中书店聆听轻音乐》[FLAC/分轨][399.62MB]
- 证声音乐图书馆《走向自然 疗心爵士乐》[320K/MP3][87.4MB]
- 证声音乐图书馆《走向自然 疗心爵士乐》[FLAC/分轨][184.94MB]
- 陈慧娴.2018-Priscilla-Ism演唱会3CD(2024环球红馆40复刻系列)【环球】【WAV+CUE】
- 郑秀文.1999-我应该得到(国)【华纳】【WAV+CUE】
- 陈家慧.2011-钢琴酒吧2CD【龙吟唱片】【WAV+CUE】
- 证声音乐图书馆《雨季 蓝调吉他 Rainy Blues》[320K/MP3][45.01MB]
- 证声音乐图书馆《雨季 蓝调吉他 Rainy Blues》[FLAC/分轨][109.13MB]
- 赞多《序章》[320K/MP3][45.54MB]
- 许巍.2004-每一刻都是崭新的【步升大风】【WAV+CUE】
- 群星.2024-四方馆影视原声带【韶愔音乐】【FLAC分轨】
- 陈雷.1997-安锁咧【金圆唱片】【WAV+CUE】
- 关淑怡.2013-MY.FAVORITE.SK.3CD【环球】【WAV+CUE】
- Sweety.2006-花言乔语【丰华】【WAV+CUE】