json - Swagger-ui api(资源)的名字是怎么生成的？

Question

这个问题在这里已经有了答案:

SwaggerUI: Path shows "Default". How can I change? (1 个回答)

关闭 5年前。

当我使用 swagger 创建 API 时，通常我的 API 具有资源的名称:

Tasks
/tasks
/tasks/{id}
etc.

有时我只得到一个默认值:

Default
GET /tasks
GET /tasks/{uuid}
etc.

什么决定了生成的 API 的 header 名称？

希望行为的屏幕截图(任务有时是默认设置):

Answer 1

您是指 Swagger UI 中的这些标题吗？

它们是根据您的 API 操作的 tags 生成的。例如，要将操作分组到“任务”下，请使用:

{
  ...

  "paths": {
    "\/tasks:": {
       "tags": [
         "Tasks"
       ],
       ...

每个操作可以有任意数量的标签。没有标签的操作将列在“默认”组下。

要为标签提供描述，请使用顶级 tags 部分:

{
  ...

  "tags": [
    {
      "name": "Tasks",
      "description": "Operations to manage tasks"
      }
    },
    {
      "name": "Notes",
      "description": "Operations to manage notes"
      }
    }
  ],
  ...