Flask API文档 #

一、Swagger概述 #

1.1 什么是Swagger #

Swagger是一种API文档规范，可以自动生成和展示API文档。

1.2 安装Flask-RESTX #

bash

pip install flask-restx

二、使用Flask-RESTX #

2.1 基本配置 #

python

from flask import Flask
from flask_restx import Api

app = Flask(__name__)
api = Api(app, version='1.0', title='API文档',
    description='API接口文档')

2.2 定义模型 #

python

from flask_restx import fields

user_model = api.model('User', {
    'id': fields.Integer(description='用户ID'),
    'username': fields.String(description='用户名'),
    'email': fields.String(description='邮箱')
})

2.3 文档化资源 #

python

from flask_restx import Resource

@api.route('/users/<int:id>')
@api.response(404, '用户不存在')
class UserResource(Resource):
    @api.doc('get_user')
    @api.marshal_with(user_model)
    def get(self, id):
        return User.query.get_or_404(id)

三、访问文档 #

启动应用后访问 / 或 /swagger.json 查看API文档。

四、下一步 #

接下来让我们学习错误处理，了解Flask错误处理！