使用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网络编程学习笔记(一)
Jun 09 Python
Python基于pygame实现图片代替鼠标移动效果
Nov 11 Python
详解Python如何获取列表(List)的中位数
Aug 12 Python
深入理解Django的自定义过滤器
Oct 17 Python
python之当你发现QTimer不能用时的解决方法
Jun 21 Python
python实现通过队列完成进程间的多任务功能示例
Oct 28 Python
python框架flask入门之路由及简单实现方法
Jun 07 Python
Python定时任务框架APScheduler原理及常用代码
Oct 05 Python
python爬虫scrapy基于CrawlSpider类的全站数据爬取示例解析
Feb 20 Python
python爬虫scrapy基本使用超详细教程
Feb 20 Python
python lambda的使用详解
Feb 26 Python
Python入门之基础语法详解
May 11 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
利用PHP创建动态图像
2006/10/09 PHP
php获取用户IPv4或IPv6地址的代码
2012/11/15 PHP
php防止sql注入示例分析和几种常见攻击正则表达式
2014/01/12 PHP
PHP判断表单复选框选中状态完整例子
2014/06/24 PHP
PHP将session信息存储到数据库的类实例
2015/03/04 PHP
PHP巧妙利用位运算实现网站权限管理的方法
2017/03/12 PHP
SCP远程VPS快速搬家和WDCP升级php5.3安装memcached和eaccelerator教程
2017/07/27 PHP
PHP批斗大会之缺失的异常详解
2019/07/09 PHP
网页里控制图片大小的相关代码
2006/06/25 Javascript
JavaScript 学习笔记(十四) 正则表达式
2010/01/22 Javascript
select标签模拟/美化方法采用JS外挂式插件
2013/04/01 Javascript
Javascript实现返回上一页面并刷新的小例子
2013/12/11 Javascript
JavaScript实现跨浏览器的添加及删除事件绑定函数实例
2015/08/04 Javascript
JavaScript中获取时间的函数集
2016/08/16 Javascript
etmvc+jQuery EasyUI+combobox多值操作实现角色授权实例
2016/11/09 Javascript
解决Layui数据表格显示无数据提示的问题
2019/11/14 Javascript
vue实现的多页面项目如何优化打包的步骤详解
2020/07/19 Javascript
用js实现放大镜效果
2020/10/28 Javascript
vue穿梭框实现上下移动
2021/01/29 Vue.js
Django自定义认证方式用法示例
2017/06/23 Python
Django 多语言教程的实现(i18n)
2018/07/07 Python
简单了解python 邮件模块的使用方法
2019/07/24 Python
python3 selenium自动化 下拉框定位的例子
2019/08/23 Python
python 串口读取+存储+输出处理实例
2019/12/26 Python
python利用opencv实现SIFT特征提取与匹配
2020/03/05 Python
Python3如何实现Win10桌面自动切换
2020/08/11 Python
input元素的url类型和email类型简介
2012/07/11 HTML / CSS
施华洛世奇德国官网:SWAROVSKI德国
2017/02/01 全球购物
建筑工地质量标语
2014/06/12 职场文书
2014年资料员工作总结
2014/11/18 职场文书
2014年社团工作总结范文
2014/11/27 职场文书
优秀教师单行材料
2014/12/16 职场文书
Python图片处理之图片裁剪教程
2021/05/27 Python
Python的这些库,你知道多少?
2021/06/09 Python
docker-compose部署Yapi的方法
2022/04/08 Servers
create-react-app开发常用配置教程
2022/06/25 Javascript