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接口文档编写就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持我们。
原文地址:https://www.jb51.cc/python/526751.html
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。