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

更新时间：2019年11月19日 15:12:46 作者：Gary5556

今天小编就为大家分享一篇使用apiDoc实现python接口文档编写，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧

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 matplotlib绘图可视化知识点整理(小结)
这篇文章主要介绍了Python matplotlib绘图可视化知识点整理(小结),小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2018-03-03
对Pytorch中Tensor的各种池化操作解析
今天小编就为大家一篇对Pytorch中Tensor的各种池化操作解析，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-01-01
Python实现指定数组下标值正序与倒序排序算法功能举例
在程序中,经常需要按数组倒序或反序重新排列数组,下面这篇文章主要给大家介绍了关于Python实现指定数组下标值正序与倒序排序算法功能的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
2023-02-02
Django更新models数据库结构步骤
这篇文章主要介绍了Django更新models数据库结构的操作步骤，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2020-04-04
使用Python提取文本中含有特定字符串的方法示例
这篇文章主要给大家介绍了关于如何使用Python提取文本中含有特定字符串的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-12-12
基于Numba提高python运行效率过程解析
这篇文章主要介绍了基于Numba提高python运行效率过程解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-03-03
python spotlight库简化交互式方法探索数据分析
这篇文章主要为大家介绍了python spotlight库简化的交互式方法探索数据,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
2024-01-01
零基础小白多久能学会python
在本篇文章里小编给大家分享的是一篇关于零基础学python要多久的相关文章内容，有兴趣的朋友们可以跟着学习下。
2020-06-06
Python操作csv文件实例详解
这篇文章主要为大家详细介绍了Python操作csv文件的实例，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-07-07
python实现3D地图可视化
这篇文章主要为大家详细介绍了python实现3D地图可视化，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2020-03-03