使用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的Django框架使用
Feb 18 Python
如何利用Fabric自动化你的任务
Oct 20 Python
使用python的turtle绘画滑稽脸实例
Nov 21 Python
TENSORFLOW变量作用域(VARIABLE SCOPE)
Jan 10 Python
Pytorch 计算误判率,计算准确率,计算召回率的例子
Jan 18 Python
python图片剪裁代码(图片按四个点坐标剪裁)
Mar 10 Python
python进行参数传递的方法
May 12 Python
PyInstaller的安装和使用的详细步骤
Jun 02 Python
使用K.function()调试keras操作
Jun 17 Python
python中plt.imshow与cv2.imshow显示颜色问题
Jul 16 Python
Python常用数字处理基本操作汇总
Sep 10 Python
基于python判断字符串括号是否闭合{}[]()
Sep 21 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
twig模板常用语句实例小结
2016/02/04 PHP
php preg_match的匹配不同国家语言实例
2016/12/29 PHP
PHP的mysqli_thread_id()函数讲解
2019/01/24 PHP
TinyMCE 新增本地图片上传功能
2010/11/05 Javascript
MooBox 基于Mootools的对话框插件
2012/01/20 Javascript
javascript中注册和移除事件的4种方式
2013/03/20 Javascript
asp.net中System.Timers.Timer的使用方法
2013/03/20 Javascript
php的文件上传入门教程(实例讲解)
2014/04/10 Javascript
node.js中的fs.lstatSync方法使用说明
2014/12/16 Javascript
基于JavaScript实现鼠标悬浮弹出跟随鼠标移动的带箭头的信息层
2016/01/18 Javascript
nodejs中向HTTP响应传送进程的输出
2017/03/19 NodeJs
Bootstrap响应式表格详解
2017/05/23 Javascript
Vue.js对象转换实例
2017/06/07 Javascript
基于javascript中的typeof和类型判断(详解)
2017/10/27 Javascript
JS实现的input选择图片本地预览功能示例
2018/08/29 Javascript
jQuery实现鼠标移入移出事件切换功能示例
2018/09/06 jQuery
原生js实现日期选择插件
2020/05/21 Javascript
Vue中computed和watch有哪些区别
2020/12/19 Vue.js
python实现按任意键继续执行程序
2016/12/30 Python
python 读文件,然后转化为矩阵的实例
2018/04/23 Python
Tensorflow中使用tfrecord方式读取数据的方法
2018/06/19 Python
两个元祖T1=('a', 'b'),T2=('c', 'd')使用匿名函数将其转变成[{'a': 'c'},{'b': 'd'}]的几种方法
2019/03/05 Python
python用win32gui遍历窗口并设置窗口位置的方法
2019/07/26 Python
python实现图片压缩代码实例
2019/08/12 Python
pytorch自定义二值化网络层方式
2020/01/07 Python
Django搭建项目实战与避坑细节详解
2020/12/06 Python
HTML5 Canvas的常用线条属性值总结
2016/03/17 HTML / CSS
牵手50新加坡:专为黄金岁月的单身人士而设的交友网站
2020/08/16 全球购物
大学生毕业自我鉴定范文
2013/11/03 职场文书
企划主管岗位职责
2013/12/12 职场文书
运动会广播稿100字
2014/01/11 职场文书
银行员工职业规划范文
2014/01/21 职场文书
党员岗位承诺口号大全
2014/03/28 职场文书
有限责任公司股东合作协议书
2014/12/02 职场文书
mysql中between的边界,范围说明
2021/06/08 MySQL
nginx结合openssl实现https的方法
2021/07/25 Servers