使用apiDoc实现python接口文档编写
作者：Gary5556 发布时间：2023-10-23 21:28:40
标签：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"
}
"""
来源：https://blog.csdn.net/zjh_lll/article/details/80093165
0
投稿猜你喜欢
- Brendan Eich于1995年在Netscape发明了JavaScript语言，这个语言在过去的一些年里曾是一个最被误解的语言，随着A
- 问题：编写一个在1，2，…，9（顺序不能变）数字之间插入+或-或什么都不插入，使得计算结果总是100的程序，并输出所有的可能性。例如：1 +
- mergemerge 函数通过一个或多个键将数据集的行连接起来。场景：针对同一个主键存在的两张包含不同特征的表，通过主键的链接，将两张表进行
- 不是炒冷饭,我添加了很多新的功能哦演示地址: xwinhtcdemo.htmCSS: global.cssHTC: xwin.htc特点:1
处理前文件内容代码处理后的# 读取代码fr = open('three.txt', 'r')dic = {}- 前言在Python中，import操作应该算是最为频繁和常见的，但同时也应该是最核心需要搞清楚其工作原理的地方，比如，python是如何找到
- 前言最近找几个老友准备聊天发现几个已经被删除好友名单，做为潜水党多年的我已经不知道成为多少人的黑名单，但是好友列表却依然有不是好友的名单，面
- 当功能比较简单，在单一html中使用vue.js分页展示数据，并未安装脚手架，或使用相关UI框架，此时需要手写一个分页器，不失为最合理最便捷
- 本文实例讲述了mysql多个left join连接查询用法。分享给大家供大家参考，具体如下：mysql查询时需要连接多个表时，比如查询订单的
- 呵，以前也没考虑过这方面的东西，现在写的代码越来越多，越来越复杂，如果再不把不用的变量及时释放掉，到时肯定会出问题。今天无意中在无忧Q群里看
- 本文实例讲述了Python画图的基本方法。分享给大家供大家参考，具体如下：Python:使用matplotlib绘制图表python绘制图表
- 一、PDF转为MP3 我们平常看到很多文件都是PDF格式，网上的各类书籍多为此格式。有时候不方便阅读，或者怕费眼睛伤颈椎，那么有没
- 本文主要讲解如何使用python绘制三维的柱形图，如下图源代码如下：import numpy as npimport matplotlib.
- 本文实例总结了PHP常用字符串函数用法。分享给大家供大家参考，具体如下：字符串函数explore使用一个字符串分割另一个字符串结果为数组&l
- Pycharm使用cv2无法安装很多学python的朋友们都会使用一个编译器，叫做Pycharm，这个编译器我也在用，那么同时在使用时也会出
- sort()方法排序列表中的对象，比较使用func(如果给定)。语法以下是sort()方法的语法：list.sort([func
- 利用Opencv中的Houghline方法进行直线检测—python语言这是给Python部落翻译的文章，请在这里看原文。在图像处理中，霍夫
- 今天给大家分享一下最新版阿里大于的短信验证码在node koa2的实现，还是有很多坑需要注意。首先需要在阿里云注册账号，并获取阿里云访问秘钥
- 1.where语法和用法(1)语法：where <criteria> 即where <查询条件>具体查询语句：sel
- 一、线程队列queue队列：使用方法同进程的Queue一样如果必须在多个线程之间安全地交换信息时，队列在线程编程中尤其有用。重要：q.put
