使用apiDoc实现python接口文档编写


Posted in Python onNovember 19, 2019

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接口文档编写就是小编分享给大家的全部内容了,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Python 相关文章推荐
python分布式环境下的限流器的示例
Oct 26 Python
Java与Python两大幸存者谁更胜一筹呢
Apr 12 Python
Python学习_几种存取xls/xlsx文件的方法总结
May 03 Python
详解Django-restframework 之频率源码分析
Feb 27 Python
python实现几种归一化方法(Normalization Method)
Jul 31 Python
python SocketServer源码深入解读
Sep 17 Python
基于pytorch padding=SAME的解决方式
Feb 18 Python
利用Python实现Json序列化库的方法步骤
Sep 09 Python
基于Django集成CAS实现流程详解
Nov 28 Python
Python import模块的缓存问题解决方案
Jun 02 Python
浅析Python中的套接字编程
Jun 22 Python
Python中如何处理常见报错
Jan 18 Python
wxPython绘图模块wxPyPlot实现数据可视化
Nov 19 #Python
Python浮点数四舍五入问题的分析与解决方法
Nov 19 #Python
python 上下文管理器及自定义原理解析
Nov 19 #Python
浅析python中while循环和for循环
Nov 19 #Python
django实现web接口 python3模拟Post请求方式
Nov 19 #Python
wxPython+Matplotlib绘制折线图表
Nov 19 #Python
python元组的概念知识点
Nov 19 #Python
You might like
实例(Smarty+FCKeditor新闻系统)
2007/01/02 PHP
Apache环境下PHP利用HTTP缓存协议原理解析及应用分析
2010/02/16 PHP
采用PHP函数memory_get_usage获取PHP内存清耗量的方法
2011/12/06 PHP
PHP对表单提交特殊字符的过滤和处理方法汇总
2014/02/18 PHP
PHP常用正则表达式集锦
2014/08/17 PHP
如何在旧的PHP系统中使用PHP 5.3之后的库
2015/12/02 PHP
thinkPHP自动验证机制详解
2016/12/05 PHP
简单三步,搞掂内存泄漏
2007/03/10 Javascript
一个很酷的拖动层的js类,兼容IE及Firefox
2009/06/23 Javascript
javascript GUID生成器实现代码
2009/10/31 Javascript
JavaScript表单通过正则表达式验证电话号码
2014/03/14 Javascript
使用变量动态设置js的属性名
2014/10/19 Javascript
在JavaScript中操作时间之getMonth()方法的使用
2015/06/10 Javascript
jQuery实现调整表格单列顺序完整实例
2016/06/20 Javascript
vue实现样式之间的切换及vue动态样式的实现方法
2017/12/19 Javascript
React 使用browserHistory项目访问404问题解决
2018/06/01 Javascript
vue强制刷新组件的方法示例
2019/02/28 Javascript
解决一个微信号同时支持多个环境网页授权问题
2019/08/07 Javascript
关于layui 实现点击按钮添加一行(方法渲染创建的table)
2019/09/29 Javascript
javascript 内存模型实例详解
2020/04/18 Javascript
Nodejs实现微信分账的示例代码
2021/01/19 NodeJs
[50:27]OG vs LGD 2018国际邀请赛淘汰赛BO3 第一场 8.26
2018/08/30 DOTA
Python中字符串格式化str.format的详细介绍
2017/02/17 Python
python使用matplotlib绘图时图例显示问题的解决
2017/04/27 Python
python实现二叉树的遍历
2017/12/11 Python
TensorFlow 滑动平均的示例代码
2018/06/19 Python
基于Python中求和函数sum的用法详解
2018/06/28 Python
对python中Librosa的mfcc步骤详解
2019/01/09 Python
详解用python计算阶乘的几种方法
2019/08/14 Python
使用python切片实现二维数组复制示例
2019/11/26 Python
Python3+RIDE+RobotFramework自动化测试框架搭建过程详解
2020/09/23 Python
美国珠宝网上商店:Jeulia
2016/09/01 全球购物
精神病医院见习报告
2014/11/03 职场文书
营业员岗位职责范本
2015/04/14 职场文书
运动会通讯稿200字
2015/07/20 职场文书
2016年万圣节活动个人总结
2016/04/05 职场文书