如何使用 Flask-RESTX 在 PyCharm 的 Swagger UI 中添加方法描述

问题描述 投票:0回答:2

我使用 Swagger 作为我的 API 工具框架,我刚刚找到这个页面:https://petstore.swagger.io/ 并看到每个方法如何有描述。

例如:

POST: pet/
被描述为
add a new Pet to the store
.

我想在 PyCharm 中添加这种描述,使用 Flask-RESTX。我怎样才能做到这一点?我阅读了 RESTX 的规范页面,但没有找到任何有用的帮助。

python pycharm swagger-ui flask-restx
2个回答
0
投票

Flask-swagger 提供了一种方法(swagger),用于检查 Flask 应用程序的端点是否包含带有 Swagger 2.0 操作对象的 YAML 文档字符串。

所以这是一种添加描述和摘要的方法。

class Data(Resource):
   @api.doc(description="getSomething")
   def get(self):
      """getsomething"""
      ....

然后它会添加描述和摘要。


-1
投票

你应该有一个 swagger.yml.

summary: <your description here>

基本结构

© www.soinside.com 2019 - 2024. All rights reserved.