当前位置: 首页 > 知识库问答 >
问题:

Springfox@RestController命名

聂建茗
2023-03-14
@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() {
    //...
    }
}

共有1个答案

景才英
2023-03-14

尝试使用@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中的所有文档化操作与标记“Application Status”分组。

 类似资料:
  • 我尝试使用@api和@apimodel来重命名我的api引用,但似乎什么都不起作用。它总是使用类名。Im使用swagger2+springfox 2.4+Springboot。

  • Springfox的前身是swagger-springmvc,是一个开源的API doc框架,可以将我们的Controller的方法以文档的形式展现。 pom依赖: <!--springfox依赖--><dependency>    <groupId>com.mangofactory</groupId>    <artifactId>swagger-springmvc</artifactId>  

  • 我使用的是swagger版本2.2.2。如果我转到地址http://localhost:8080/swagger-ui.html,我将直接获得swagger UI。有没有办法,一个安全层可以增加,像,用户应该提示输入用户id和密码之前,大摇大摆的UI显示?

  • 在springboot应用程序上下文中,我正在查找swagger的.json输出。

  • 但对于本地时间来说,我仍然在swagger-ui的示例和模型中得到这些 我读过一些东西,swagger规范不使用时间格式。这是不是有些关联?

  • 当我运行以下请求时,web服务中出现了一些异常。 远程地址:127.0.0.1:8080请求URL:http://localhost:8080/imageupload请求方法:post状态代码:500内部服务器错误请求头视图源接受:application/json,text/plain,/接受-编码:gzip,deflate接受-语言:en-us,en;q=0.8连接:keep-alive内容-长