明霞山资源网 Design By www.htccd.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.htccd.com
广告合作:本站广告合作请联系QQ:858582 申请时备注:广告合作(否则不回)
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
明霞山资源网 Design By www.htccd.com
暂无评论...
RTX 5090要首发 性能要翻倍!三星展示GDDR7显存
三星在GTC上展示了专为下一代游戏GPU设计的GDDR7内存。
首次推出的GDDR7内存模块密度为16GB,每个模块容量为2GB。其速度预设为32 Gbps(PAM3),但也可以降至28 Gbps,以提高产量和初始阶段的整体性能和成本效益。
据三星表示,GDDR7内存的能效将提高20%,同时工作电压仅为1.1V,低于标准的1.2V。通过采用更新的封装材料和优化的电路设计,使得在高速运行时的发热量降低,GDDR7的热阻比GDDR6降低了70%。