使用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的加密模块md5、sha、crypt使用实例
Sep 28 Python
Python与Redis的连接教程
Apr 22 Python
Python 爬虫爬取指定博客的所有文章
Feb 17 Python
python爬虫获取京东手机图片的图文教程
Dec 29 Python
Python字符串格式化%s%d%f详解
Feb 02 Python
Python数据持久化shelve模块用法分析
Jun 29 Python
tensorflow 初始化未初始化的变量实例
Feb 06 Python
使用Bazel编译TensorBoard教程
Feb 15 Python
Python自动巡检H3C交换机实现过程解析
Aug 14 Python
python des,aes,rsa加解密的实现
Jan 16 Python
Python排序算法之插入排序及其优化方案详解
Jun 11 Python
用python基于appium模块开发一个自动收取能量的小助手
Sep 25 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 函数call_user_func和call_user_func_array用法详解
2014/03/02 PHP
php事务处理实例详解
2014/07/11 PHP
ECSHOP完美解决Deprecated: preg_replace()报错的问题
2016/05/17 PHP
浅谈htmlentities 、htmlspecialchars、addslashes的使用方法
2016/12/09 PHP
php实现评论回复删除功能
2017/05/23 PHP
laravel orm 关联条件查询代码
2019/10/21 PHP
最新优化收藏到网摘代码(digg,diigo)
2007/02/07 Javascript
Locate a File Using a File Open Dialog Box
2007/06/18 Javascript
JQuery的一些小应用收集
2010/03/27 Javascript
js的.innerHTML = ""IE9下显示有错误的解决方法
2013/09/16 Javascript
javascript动态向网页中添加表格实现代码
2014/02/19 Javascript
解析javascript中鼠标滚轮事件
2015/05/26 Javascript
基于jQuery实现的向下滑动二级菜单效果代码
2015/08/31 Javascript
AngularJS基础 ng-keydown 指令简单示例
2016/08/02 Javascript
javascript编程实现栈的方法详解【经典数据结构】
2017/04/11 Javascript
手把手教你把nodejs部署到linux上跑出hello world
2017/06/19 NodeJs
addeventlistener监听scroll跟touch(实例讲解)
2017/08/04 Javascript
js 两个日期比较相差多少天的实例
2017/10/19 Javascript
angular4笔记系列之内置指令小结
2018/11/09 Javascript
vue路由 遍历生成复数router-link的例子
2019/10/30 Javascript
原生JS实现微信通讯录
2020/06/18 Javascript
wxPython 入门教程
2008/10/07 Python
Python分析学校四六级过关情况
2017/11/22 Python
Python的条件表达式和lambda表达式实例
2019/01/31 Python
详解python爬虫系列之初识爬虫
2019/04/06 Python
Python使用tkinter实现小时钟效果
2021/02/22 Python
html5中为audio标签增加停止按钮动作实现方法
2013/01/04 HTML / CSS
香港No.1得奖零食网:香港零食大王
2016/07/22 全球购物
Farah官方网站:男士服装及配件
2019/11/01 全球购物
个人简历自我鉴定
2013/10/11 职场文书
保护地球的宣传语
2015/07/13 职场文书
2016三八妇女节慰问信
2015/11/30 职场文书
2016反腐倡廉警示教育心得体会
2016/01/13 职场文书
解除合同协议书范本
2016/03/21 职场文书
springboot如何接收application/x-www-form-urlencoded类型的请求
2021/11/02 Java/Android
vue3.0 数字翻牌组件的使用方法详解
2022/04/20 Vue.js