当我的函数中有多个 http 方法（GET，POST）时，如何使用 flasgger 编写 API 文档？

Question

我正在使用 flasgger 编写我的 API 文档，我的一个函数同时具有 GET 和 POST method.The 问题是 flasgger 无法区分 GET 和POST 方法。我只为 post 方法编写了代码，但它也将该代码与 GET 方法相关联

我附上了显示我编写的代码的图片，正如你所看到的，我在这里编写了仅用于 POST 方法的代码，但它也将它与 GET 方法相关联，因为如图2所示

此图显示了 GET 和 POST 方法的招摇 UI。正如您所看到的，对于 GET 方法，它显示与 POST 方法相同的结果，即使我没有为 GET 方法编写任何内容。

我想使用docstring方式将swagger集成到我的代码中，我该怎么办？

Answer 1

Flasgger 实际上能够区分在不同 http 方法上运行的单个函数的文档。但是，它无法从单个文档字符串创建两个单独的文档。 flasgger 文档提供的解决方案描述如下：

https://github.com/rochacbruno/flasgger#handling-multiple-http-methods-and-routes-for-a-single-function

@app.route('/api/<string:username>', endpoint='with_user_name', methods=['PUT', 'GET'])
@app.route('/api/', endpoint='without_user_name')
@swag_from('path/to/external_file.yml', endpoint='with_user_name')
@swag_from('path/to/external_file_no_user_get.yml', endpoint='without_user_name', methods=['GET'])
@swag_from('path/to/external_file_no_user_put.yml', endpoint='without_user_name', methods=['PUT'])

...但它需要将文档保存在单独的文件中。

当我的函数中有多个 http 方法（GET，POST）时，如何使用 flasgger 编写 API 文档？

How to write API documentation using flasgger when my function has multiple http methods (GET, POST) in it?

python

api

flask

swagger

flasgger