如何在Sanic-openapi中设置Tag描述?

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

我有一个 Python Sanic 服务器,现在将 Swagger 配置添加到端点。我使用 Sanic OpenAPI 21.6.0

我可以向端点添加标签以对它们进行分组,但找不到如何添加标签描述。 doc.tag() 只接受一个参数并将其作为标签名称。

@api.get('inlens/admin/lookup')
@doc.tag('Admin')
async def get_job_status(request, user):

我想要的是这样的: tag description

swagger sanic sanic-openapi
2个回答
0
投票

使用

summary
添加标签描述:

@api.get('inlens/admin/lookup')
@doc.tag('Admin')
@doc.summary('This is admin description')
def get_job_status(request):
    ...

enter image description here


0
投票
from sanic_ext.extensions.openapi.definitions import Tag

app.ext.openapi.tags['TasksAPI'] = Tag('TasksAPI', description='description')

甚至:

app.ext.openapi.tags['TasksAPI'] = app.ext.openapi.tag(
  'TasksAPI',
  description="Manage and monitor tasks executions"
)
© www.soinside.com 2019 - 2024. All rights reserved.