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

Gob*_*ins 3 json swagger swagger-ui

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

Tasks
/tasks
/tasks/{id}
etc.
Run Code Online (Sandbox Code Playgroud)

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

Default
GET /tasks
GET /tasks/{uuid}
etc.
Run Code Online (Sandbox Code Playgroud)

什么决定了生成的 API 的标头名称?

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

在此处输入图片说明

Hel*_*len 5

您是说 Swagger UI 中的这些标题吗?

标题

它们是根据tags您的 API 操作生成的。例如,要在“任务”下对操作进行分组,请使用:

{
  ...

  "paths": {
    "\/tasks:": {
       "tags": [
         "Tasks"
       ],
       ...
Run Code Online (Sandbox Code Playgroud)

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

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

{
  ...

  "tags": [
    {
      "name": "Tasks",
      "description": "Operations to manage tasks"
      }
    },
    {
      "name": "Notes",
      "description": "Operations to manage notes"
      }
    }
  ],
  ...
Run Code Online (Sandbox Code Playgroud)