Springfox @RestController命名

Question

我在使用Springfox时遇到了一些小问题。我不能为@RestController类设置名称。

我使用的是Spring boot和Swagger2。

下面的代码将在springfox ui中生成一个名为"rest-status- controller“的控制器。我期望看到的是“应用程序状态”。有没有其他我不知道的配置？

@Api("Application Status")
@RestController
@RequestMapping("/rest/status")
public class RestStatusController {

    @ApiOperation(value="Get components current status")
    @RequestMapping(method = RequestMethod.GET, produces=MediaType.APPLICATION_JSON)
    public String global() {
    //...
    }

    @ApiOperation(value="Get mysql current status")
    @RequestMapping(value="/mysql" method = RequestMethod.GET, produces=MediaType.APPLICATION_JSON)
    public String mysql() {
    //...
    }
}

Answer 1

尝试使用@Api注释的tags参数来更改RestController方法分组的名称。摘自相应的Java文档(简称)：

/**
 * A list of tags for API documentation control.
 * Tags can be used for logical grouping of operations by resources or any other qualifier.
 */
String[] tags() default "";

在您的情况下，只需使用：

@Api(tags = "Application Status")
@RestController
@RequestMapping("/rest/status")
public class RestStatusController {
    ...
}

这应该使用“应用程序状态”标签对来自RestStatusController的所有记录的操作进行分组。

Answer 2

同时使用标记和描述，以避免控制器名称API分组。例如：

@Api(
  tags="Application Status.",
  description = "Provides Application Status API's.
")

Answer 3

根据OpenApi v3的@Tags(name = "name", description = "description")