python - Python REST-API 与 Flask-RestX 和 JavaScript REST-Client 一起提供服务

Question

我运行这个示例：https : //flask-restx.readthedocs.io/en/latest/example.html（带有 Flask-RESTX 的 Python REST-API）

代码片段

app = Flask(__name__)
api = Api(app, ...)
ns = api.namespace('todos', ...)

@ns.route('/')
...
@ns.route('/<int:id>')
...

结果

我得到了 REST-API 的以下 URL：

http://127.0.0.1:5000 -> Swagger 文档

http://127.0.0.1:5000/swagger.json

http://127.0.0.1:5000/todos/

http://127.0.0.1:5000/todos/{id}

问题

我想用 Javascript 实现一个 Webclient，应该通过以下 URL 访问：

http://127.0.0.1:5000 -> index.html

http://127.0.0.1:5000/style.css

http://127.0.0.1:5000/app.js

REST-API 的 URL 应更改为：

http://127.0.0.1:5000/api -> Swagger 文档

http://127.0.0.1:5000/api/swagger.json

http://127.0.0.1:5000/api/todos/

http://127.0.0.1:5000/api/todos/{id}

如何扩展示例以生成所需的 URL？

Answer 1

您可以使用 flask.Blueprint 包装 flask-restx 应用程序，以在特定 url_path 下移动 swagger 逻辑。

以下示例显示了如何实现这一点：

import flask
import flask_restx


APP = flask.Flask("my-app")
api_bp = flask.Blueprint("api", __name__, url_prefix="/api")

API = flask_restx.Api(api_bp)
APP.register_blueprint(api_bp)


NAMESPACE = API.namespace("todos")


@NAMESPACE.route("/")
class TODOSAPI(flask_restx.Resource):
    def get(self):
        return ['todo-1', 'todo-2']

Answer 2

不知道你现在是否得到了答案。我经常为烧瓶 restx 样板克隆下面的 github 项目。它被设计为一个休息样板，以帮助您启动和运行。

https://github.com/cosmic-byte/flask-restplus-boilerplate

模板和静态文件可以添加到应用程序和控制器中以托管页面。为静态页面添加了以下文档。每一个都应该在那里让你运行一个完整的站点

https://flask.palletsprojects.com/en/1.1.x/tutorial/static/