将ApiDoc支架添加到烧瓶上
Flask-Apidoc-Extend的Python项目详细描述
烧瓶ApiDoc Extend
Flask ApiDoc Extend是一个Flask扩展，它增加了对ApiDoc的支持。在
特点
- 托管apidoc的文件，默认情况下它们托管在http://localhost:5000/apidoc
- 将apidoc的文件导出到Markdown。apidoc.md公司将生成输出文件夹。默认情况下它在
/static/docs下面。在
安装
您需要先安装apidoc。在
$ npm install apidoc -g
然后可以通过Python包索引（PyPI）安装flaskapidoc
$ pip install flask-apidoc-extend
使用
- 创建一个apidoc.json文件在你的项目下归档。在
yourproject/apidoc.json文件
像这样：
{
"name": "Flask REST API Doc",
"version": "1.0.0",
"description": "A Flask REST API Doc example",
"title": "A Flask REST API Doc example",
"url" : "http://localhost:5000"
}
- 初始化Apidoc并将您的flask应用程序传递给它。在
ApiDoc参数。在
^{pr2}$示例：
from flask_apidoc_extend import ApiDoc
app = Flask(__name__)
ApiDoc(app=app)
- 在源代码中的任何位置添加一些apidoc注释：
"""
@api {get} /user/:id Request User information
@apiName GetUser
@apiGroup User
@apiParam {Number} id User's unique ID.
@apiSuccess {String} firstname Firstname of the User.
@apiSuccess {String} lastname Lastname of the User.
"""
- 生成apidoc文件
$ cd yourproject/
$ flask apidoc
$ flask run
现在您可以通过http://127.0.0.1:5000/apipdoc访问apidoc文件
- 导出到降价（版本>；=0.1.6）
此命令将apidoc文件导出到markdown（apidoc.md公司）。在
$flask apidoc --export
默认情况下，您可以在/static/docs下找到降价文件。在
note：您的apidoc.json文件文件必须设置在yourproject/下，并且应该在同一路径上运行命令。在
反馈
- 项目
标签：
欢迎加入QQ群-->： 979659372
