首页
学习
活动
专区
圈层
工具
发布
社区首页 >专栏 >Flask-RESTful-API文档的生成和发布(三)

Flask-RESTful-API文档的生成和发布(三)

原创
作者头像
堕落飞鸟
发布2023-05-06 16:24:41
发布2023-05-06 16:24:41
7800
举报
文章被收录于专栏:飞鸟的专栏飞鸟的专栏

使用Redoc

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

首先,我们需要安装flask-redoc扩展:

代码语言:javascript
复制
pip install flask-redoc

然后,我们需要使用flask_redocRedoc类来配置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_redocRedoc类,并创建了一个redoc对象。然后,在程序运行时,我们可以通过访问http://localhost:5000/redoc/来查看生成的Redoc UI。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

原创声明:本文系作者授权腾讯云开发者社区发表,未经许可,不得转载。

如有侵权,请联系 cloudcommunity@tencent.com 删除。

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 使用Redoc
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档