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

yipeiwu_com6年前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画图,发现生成的图片在console里。不仅感觉很别扭,很多功能也没法实现(比如希望在一幅图里画两条曲线)。 想像matlab一样单独地生成一个图片窗口,然后我在网上找了...

python中函数总结之装饰器闭包详解

1、前言 函数也是一个对象,从而可以增加属性,使用句点来表示属性。 如果内部函数的定义包含了在外部函数中定义的对象的引用(外部对象可以是在外部函数之外),那么内部函数被称之为闭包。 2、...

Atom Python 配置Python3 解释器的方法

环境 Mac Python3.6.4 Atom 背景 Atom 执行Python Code 使用Script Package,执行快捷键cmd + i。 但是默认是执行Mac 系统的2....

用python 批量更改图像尺寸到统一大小的方法

如下所示: #提取目录下所有图片,更改尺寸后保存到另一目录 from PIL import Image import os.path import glob def convertj...

Tensorflow 实现修改张量特定元素的值方法

最近在做一个摘要生成的项目,过程中遇到了很多小问题,从网上查阅了许多别人解决不同问题的方法,自己也在旁边开了个jupyter notebook搞些小实验,这里总结一下遇到的一些问题。 T...