使用apiDoc实现python接口文档编写
Python  /  管理员 发布于 5年前   105
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接口文档编写就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持。
原梓番博客 在
在Laravel框架中使用模型Model分表最简单的方法中评论 好久好久都没看友情链接申请了,今天刚看,已经添加。..博主 在
佛跳墙vpn软件不会用?上不了网?佛跳墙vpn常见问题以及解决办法中评论 @1111老铁这个不行了,可以看看近期评论的其他文章..1111 在
佛跳墙vpn软件不会用?上不了网?佛跳墙vpn常见问题以及解决办法中评论 网站不能打开,博主百忙中能否发个APP下载链接,佛跳墙或极光..路人 在
php中使用hyperf框架调用讯飞星火大模型实现国内版chatgpt功能示例中评论 教程很详细,如果加个前端chatgpt对话页面就完美了..博主 在
科学上网翻墙之v2rayN-Core客户端免费公益节点使用教程中评论 @ mashrdn 多切换几个节点测试,免费ssr是没那么稳..Copyright·© 2019 侯体宗版权所有· 粤ICP备20027696号