使用apiDoc进行python接口文档编写

最新推荐文章于 2024-07-28 03:40:56 发布

Gary5556

最新推荐文章于 2024-07-28 03:40:56 发布

阅读量4.6k

点赞数

本文链接：https://blog.csdn.net/zjh_lll/article/details/80093165

版权

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"
   }
"""