Swagger-ui如何生成api（资源）的名称？

Question

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

Tasks
/tasks
/tasks/{id}
etc.

有时我只会得到默认值：

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

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

希望行为的截图（任务有时是默认的）：

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"
      }
    }
  ],
  ...

Answer 2

这取决于您在RESTful服务实现的顶部作为swagger的Api注释（io.swagger.annotations.Api）的参数传递的内容 -

@Path(value="/")
@Api(value="/")
public interface YourService {
    ....
}

@Api(value="/")将生成default

@Api(value="/Tasks")将生成Tasks