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

yipeiwu_com5年前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设计】。

相关文章

解决python3在anaconda下安装caffe失败的问题

Python 跟 Python3 完全就是两种语言 1、 import caffe FAILED  环境为 Ubuntu 16 cuda 8.0 NVIDIA 361.77...

Python numpy 常用函数总结

Numpy是什么 在没给大家介绍numpy之前先给大家说下python的基本概念。 Python 是一种高级的,动态的,多泛型的编程语言。Python代码很多时候看起来就像是伪代码一样...

解决Django模板无法使用perms变量问题的方法

解决Django模板无法使用perms变量问题的方法

前言 本文主要给大家介绍了关于Django模板无法使用perms变量的解决方法,分享出来供大家参考学习,下面话不多说了,来一起看看详细的介绍吧。 解决方法: 首先,在使用Django内置...

python threading模块操作多线程介绍

python是支持多线程的,并且是native的线程。主要是通过thread和threading这两个模块来实现的。thread是比较底层的模块,threading是对thread做了一...

Python socket模块实现的udp通信功能示例

本文实例讲述了Python socket模块实现的udp通信功能。分享给大家供大家参考,具体如下: socket介绍 socket(简称 套接字) 是进程间通信的一种方式,它与其他进程间...