首页 > 解决方案 > 如何在 Sanic-openapi 中设置标签描述?

问题描述

我有一个 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):

我想要的是这样的: 标签描述

标签: swaggersanicsanic-openapi

解决方案


用于summary添加标签描述:

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

在此处输入图像描述


推荐阅读