我使用 Swagger 作为我的 API 工具框架,我刚刚找到这个页面:https://petstore.swagger.io/ 并看到每个方法如何有描述。
例如:
POST: pet/
被描述为add a new Pet to the store
.
我想在 PyCharm 中添加这种描述,使用 Flask-RESTX。我怎样才能做到这一点?我阅读了 RESTX 的规范页面,但没有找到任何有用的帮助。
Flask-swagger 提供了一种方法(swagger),用于检查 Flask 应用程序的端点是否包含带有 Swagger 2.0 操作对象的 YAML 文档字符串。
所以这是一种添加描述和摘要的方法。
class Data(Resource):
@api.doc(description="getSomething")
def get(self):
"""getsomething"""
....
然后它会添加描述和摘要。