Question

我使用Springfox遇到了一些小问题。我无法为@RestController类设置名称。

我使用的是Spring boot和Swagger2。

以下代码将生成一个名为＆＃34; rest-status-controller＆＃34;的控制器。在springfox ui。我预计会有一个＆＃34;申请状态＆＃34;代替。还有其他配置我不知道吗？

@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的所有记录操作与标记＆＃34;应用程序状态＆＃34;分组。

Answer 2

使用标记和说明来避免控制器名称API分组。例如：

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

Springfox @RestController命名

2 个答案: