使用apiDoc实现python接口文档编写
apiDoc的安装
npminstallapidoc-g
点击官方文档
生成api的终端命令：apidoc-i代码所在路径-o生成文件的路径
接口文档的编写
文件的简介
project的介绍写在单独的json文件中apidoc.json：
{"name":"project_name",
"version":"0.1.0",
"description":"whoami,whaticando",
"title":"titleofthehtmlthatgeneratedbyapiDoc",
"sampleUrl":"https://127.0.0.1:8000"}
具体api的书写模版
"""
@api{methods}urldescription
@apiNameunique_name
@apiGroupgroup
@apiParam{type}fielddescription
@apiSuccessExample{json}Success-Response:
HTTP/1.1200OK
{
"errno":200,
"errmsg":errmsg,
}
@apiErrorerrortypedescription.
@apiErrorExample{json}Error-Response:
HTTP/1.1200OK
{
"errno":401
"errmsg":"UserNotFound"
}
"""
以上这篇使用apiDoc实现python接口文档编写就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。