spring-boot - Springfox @RestController 命名

Question

我在使用 Springfox 时遇到了一些小麻烦。我无法为 @RestController 类设置名称。

我正在使用 Spring Boot 和 Swagger2。

以下代码将在 springfox ui 中生成一个名为“rest-status-controller”的 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

尝试使用 tags @Api 的参数用于更改 RestController 方法分组名称的注释。摘自相应的 Java Doc(缩短):

/**
 * 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 的所有记录操作进行分组。带有标签“应用程序状态”。