烧瓶文件生成器
Flask-Autodoc的Python项目详细描述
flask autodoc是一个flask扩展，它基于路由、函数参数和docstring自动为您的端点创建文档。
[构建]（https://api.travis ci.org/acoomans/flask autodoc.png）（https://travis ci.org/acoomans/flask autodoc）
[！[pypi版本]（http://img.shields.io/pypi/v/flask autodoc.svg）（https://pypi.python.org/pypi/flask autodoc）
[！[PYPI许可证]（http://img.shields.io/PYPI/L/flask autodoc.svg）（https://pypi.python.org/pypi/flask autodoc）
！[python 2]（http://img.shields.io/badge/python-2-blue.svg）
！[python 3]（http://img.shields.io/badge/python-3-blue.svg）
运行pip:
或克隆此目录并运行安装程序：
\auto=auto doc（app）
默认情况下，flask autodoc将只记录用“doc”显式修饰的路由：
@app.route（'/user/<；int:id>；'）
@auto.doc（）
def show_user（id）：
从数据库（id）返回user_以生成文档，使用_html（）方法：
@app.route（'/documentation'）
def documentation（）：
return auto.html（）
文档将作为规则列表返回，其中每个规则都是一个字典，其中包含：
-方法：允许的方法集（即['get'，'post']）
-规则：相对URL（即'/user/<；int:id>；'）
-端点：函数名（即“show_user”）
-文档：函数的docstring
-参数：函数参数
-默认值：参数的默认值
这将使用烧瓶模板目录中的模板。
附加参数（除“组”、“组”和“模板”之外）将传递给模板：
auto.html（
template=“自定义文档.html”
）
title=“我的文档”和“作者”将在模板中提供：
<；！--templates/custom_documentation.html-->；
…
{%if title is defined%}
{{title}
{%endif%}
…
例如，可以向第三方开发人员显示某些终结点，并为主要开发人员提供完整的文档。
若要将终结点分配给组，请将组的名称作为装饰程序的参数：
@app.route（'/user/<；int:id>；'）
@auto.doc（'public'）
def显示用户（id）：
将终结点分配给多个组，将组名列表作为“组”参数传递给“文档：
@app.route（'/user/<；int:id>；'）
@auto.doc（groups=['public'，'private']）
def show_user（id）：
将组的名称传递给html或generate方法：
auto.html（'public'）
auto.html（groups=['public'，'private']）
auto.generate（'public'）
尊敬的simple/blog.py
，连接到[/doc/public]（http://127.0.0.1:5000/doc/public）和[/doc/private]（http://127.0.0.1:5000/doc/private）查看公共和私人文档。
[截图]（screenshots/screenshot00.png）
！[截图]（screenshots/screenshot01.png）
[构建]（https://api.travis ci.org/acoomans/flask autodoc.png）（https://travis ci.org/acoomans/flask autodoc）
[！[pypi版本]（http://img.shields.io/pypi/v/flask autodoc.svg）（https://pypi.python.org/pypi/flask autodoc）
[！[PYPI许可证]（http://img.shields.io/PYPI/L/flask autodoc.svg）（https://pypi.python.org/pypi/flask autodoc）
！[python 2]（http://img.shields.io/badge/python-2-blue.svg）
！[python 3]（http://img.shields.io/badge/python-3-blue.svg）
运行pip:
或克隆此目录并运行安装程序：
\auto=auto doc（app）
默认情况下，flask autodoc将只记录用“doc”显式修饰的路由：
@app.route（'/user/<；int:id>；'）
@auto.doc（）
def show_user（id）：
从数据库（id）返回user_以生成文档，使用_html（）方法：
@app.route（'/documentation'）
def documentation（）：
return auto.html（）
文档将作为规则列表返回，其中每个规则都是一个字典，其中包含：
-方法：允许的方法集（即['get'，'post']）
-规则：相对URL（即'/user/<；int:id>；'）
-端点：函数名（即“show_user”）
-文档：函数的docstring
-参数：函数参数
-默认值：参数的默认值
这将使用烧瓶模板目录中的模板。
附加参数（除“组”、“组”和“模板”之外）将传递给模板：
auto.html（
template=“自定义文档.html”
）
title=“我的文档”和“作者”将在模板中提供：
<；！--templates/custom_documentation.html-->；
…
{%if title is defined%}
{{title}
{%endif%}
…
例如，可以向第三方开发人员显示某些终结点，并为主要开发人员提供完整的文档。
若要将终结点分配给组，请将组的名称作为装饰程序的参数：
@app.route（'/user/<；int:id>；'）
@auto.doc（'public'）
def显示用户（id）：
将终结点分配给多个组，将组名列表作为“组”参数传递给“文档：
@app.route（'/user/<；int:id>；'）
@auto.doc（groups=['public'，'private']）
def show_user（id）：
将组的名称传递给html或generate方法：
auto.html（'public'）
auto.html（groups=['public'，'private']）
auto.generate（'public'）
尊敬的simple/blog.py
，连接到[/doc/public]（http://127.0.0.1:5000/doc/public）和[/doc/private]（http://127.0.0.1:5000/doc/private）查看公共和私人文档。
[截图]（screenshots/screenshot00.png）
！[截图]（screenshots/screenshot01.png）
欢迎加入QQ群-->： 979659372
