Flask-RESTful-API文档的生成和发布（三）

使用Redoc

Redoc是另一个流行的API文档工具，它也可以将API文档呈现为交互式UI。Flask-RESTful提供了一个名为flask-redoc的扩展，可以将生成的API文档转换为Redoc UI。

首先，我们需要安装flask-redoc扩展：

代码语言：javascript复制

pip install flask-redoc

然后，我们需要使用flask_redoc的Redoc类来配置Redoc UI。以下是一个例子：

代码语言：javascript复制

from flask import Flask
from flask_restful import Api, Resource, fields, marshal_with
from flask_redoc import Redoc

app = Flask(__name__)
api = Api(app)

resource_fields = {
    'name': fields.String,
    'age': fields.Integer,
    'gender': fields.String,
}

class User(Resource):
    @marshal_with(resource_fields)
    def get(self, user_id):
        # Get user from database
        user = {'name': 'John Doe', 'age': 30, 'gender': 'male'}
        return user

api.add_resource(User, '/users/<int:user_id>', endpoint='user')

redoc = Redoc(app, title='API Documentation', openapi_url='http://localhost:5000/api/spec')

if __name__ == '__main__':
    app.run(debug=True)

在上面的例子中，我们导入了flask_redoc的Redoc类，并创建了一个redoc对象。然后，在程序运行时，我们可以通过访问http://localhost:5000/redoc/来查看生成的Redoc UI。

flask

0 人点赞