Flask-RESTX 自定义 UI

Flask-RESTX是一个基于Flask快速构建API的扩展，且具有自动生成API文档的功能，包括基于Swagger和ReDoc的UI视图两种。但是，有时我们需要一些自定义的UI视图来满足特殊需求，因此Flask-RESTX提供了自定义的UI视图接口。

自定义UI视图的接口

如果要使用自定义UI视图，我们需要在Flask-RESTX的api初始化时调用add_namespace方法，并给定一个表示API的命名空间。其中，path 表示API的路由前缀，而 validate 和 doc 参数则用来控制自动生成文档的行为。

在命名空间中，我们可以添加自定义的UI视图，并指定对应的路由和视图函数。

from flask_restx import Api, Namespace, Resource

api = Api(version='1.0', title='Sample API', description='A sample API')

ns = Namespace('custom_ui', path='/custom', validate=True, doc='/docs')

@ns.route('/')
class CustomUI(Resource):
    def get(self):
        return {'message': 'Hello, custom UI!'}
    
api.add_namespace(ns)

在这段代码中，我们首先创建了一个标准的Flask-RESTX的api，并定义了一个表示自定义UI的命名空间。之后，我们在这个名字空间内添加了一个路由为/custom的视图，该视图使用HTTP GET方法，并返回一个JSON数据。最后，我们将这个命名空间添加到api中，就可以访问这个自定义UI了。

使用自定义UI

启动Flask应用后，我们可以直接在浏览器中访问自定义UI来获取数据。我们可以在官方提供的UI视图中输入路由地址/custom，或者在自动文档页面的sidebar中找到这个接口。

The custom UI endpoint can be accessed at:

- `/custom`: A customized UI endpoint

You can access these endpoints by using the Redoc or Swagger UIs available at:

- `/docs`: OpenAPI Swagger UI
- `/redoc`: Redoc UI

小结

自定义UI视图为我们提供了灵活的API开发方式，我们可以按照自己的需求来定义和展示API视图。同时，Flask-RESTX也提供了完整的文档支持，方便我们进行开发、测试和部署。