脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → python → apiDoc python接口文档

使用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中的字典与成员运算符初步探究

    Python中的字典与成员运算符初步探究

    这篇文章主要介绍了Python中的字典与成员运算符初步探究,是Python入门学习中的基础知识,需要的朋友可以参考下
    2015-10-10
  • python Canny边缘检测算法的实现

    python Canny边缘检测算法的实现

    这篇文章主要介绍了python Canny边缘检测算法的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2020-04-04
  • 利用Pandas和Numpy按时间戳将数据以Groupby方式分组

    利用Pandas和Numpy按时间戳将数据以Groupby方式分组

    这篇文章主要介绍了利用Pandas和Numpy按时间戳将数据以Groupby方式分组，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-07-07
  • python对DICOM图像的读取方法详解

    python对DICOM图像的读取方法详解

    DICOM（Digital Imaging and Communications in Medicine）即医学数字成像和通信，是医学图像和相关信息的国际标准（ISO 12052）。下面这篇文章主要给大家介绍了关于python对DICOM图像读取的相关资料，需要的朋友可以参考借鉴，下面来一起看看吧。
    2017-07-07
  • Python实现的文本编辑器功能示例

    Python实现的文本编辑器功能示例

    这篇文章主要介绍了Python实现的文本编辑器功能,结合实例形式详细分析了基于wxpython实现文本编辑器所需的功能及相关实现技巧,需要的朋友可以参考下
    2017-06-06
  • python3在同一行内输入n个数并用列表保存的例子

    python3在同一行内输入n个数并用列表保存的例子

    今天小编就为大家分享一篇python3在同一行内输入n个数并用列表保存的例子，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2019-07-07
  • Windows下将Python文件打包成.EXE可执行文件的方法

    Windows下将Python文件打包成.EXE可执行文件的方法

    这篇文章主要介绍了Windows下将Python文件打包成.EXE可执行文件的方法,需要的朋友可以参考下
    2018-08-08
  • 全面了解Python的getattr(),setattr(),delattr(),hasattr()

    全面了解Python的getattr(),setattr(),delattr(),hasattr()

    下面小编就为大家带来一篇全面了解Python的getattr(),setattr(),delattr(),hasattr()。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2016-06-06
  • 使用 Python 实现文件递归遍历的三种方式

    使用 Python 实现文件递归遍历的三种方式

    这篇文章主要介绍了使用 Python 实现文件递归遍历的三种方式,非常不错，具有一定的参考借鉴价值，需要的朋友参考下吧
    2018-07-07
  • 基于Python制作三款起床闹钟的示例代码

    基于Python制作三款起床闹钟的示例代码

    每天上班最痛苦的事情就是早起早起早起！这是大部分上班族的痛苦，但是不上班又是不可能的啦，因为都是为了搞钱。本文用Python制作了三款有趣的闹钟，感兴趣的可以学习一下
    2022-05-05

最新评论