[Flask] 生成flask接口文档

By Heanny
2021-09-20
235 read

背景

接触过几个针对flask自动生成接口文档的,但是感觉不太好用,然后发现了flask-docs,地址:https://github.com/kwkwc/flask-docs 但是感觉还是不太好用,就进行了魔改

地址

https://gitee.com/heanny/flask-docs

添加的功能

  • 可修改接口文档分类为中文
  • 接口文档页面布局进行了优化美观
  • 生成接口文档的方法进行了重构,并添加了部分兼容逻辑
  • 添加了二级分类树
  • 添加了html网页类型展示
  • 修复部分问题
  • 文档接口搜索已修复
  • 测试页面接口及搜索已修复
  • form data可以使用,需要设置headers

TODO

  • 美化界面

增加的功能使用说明

  1. 中文类别
# 使用自定义名
# app.config["API_DOC_MEMBER_NAME"] = True
# app.config["API_DOC_MEMBER"] = {"api": "API接口", "platform": "platform 接口"}

# Api Document needs to be displayed
app.config["API_DOC_MEMBER"] = ["api", "platform"]
  1. 展示根目录html
# 显示根目录下的html路径分类
app.config["API_DOC_TEMP"] = True
  1. 修复的问题
  • 配置docs时,init_app 只需传参app即可
    修复前:修有这样title等才生效
ApiDoc(
    app,
    title="Sample App",
    version="1.0.0",
    description="A simple app API",
)

修复后:

doc = ApiDoc(
    title="Sample App",
    version="1.0.0",
    description="A simple app API",
)
doc.init_app(app)
  • doc文档标题必须是第一行
    修复前:
@api.route("/add_data", methods=["POST"])
def add_data():
    """标题只能写在这里

    @@@

修复后

@api.route("/add_data", methods=["POST"])
def add_data():
    """
	标题这样写也可以

    @@@

截图

中文类目
Html页面

树莓派安装omv(debian)

Comments

暂无评论,还不快来坐沙发...

Leave a Reply