首页 > 编程语言 > 详细

springboot+swagger2 如何给接口排序

时间:2019-11-27 16:45:02      阅读:2141      评论:0      收藏:0      [点我收藏+]

1、使用的swagger 版本

 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/swagger-bootstrap-ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

2、swagger配置

@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        ...
    }

    private ApiInfo apiInfo() {
           ...
    }
}

3、关键一点swagger注解的使用

   

@ApiSort(value = 5):给接口排序
@ApiOperationSupport(order = 1):给接口里面的方法排序,如下:
@RestController
@RequestMapping(value = "/api/message")
@Api(tags = "接口-短信")
@ApiSort(value = 5)
@ApiIgnore()
public class MessageController {


    @RequestMapping(value = "/ct", method = {RequestMethod.GET}, produces = {"application/json"})
    @ApiOperation(value = "短信总数", notes = "获取短信总数")
    @ApiOperationSupport(order = 1)
    public Result CT() {
      ...
    }

4、最后也很重要,一定要开启增强功能,然后刷新页面就可以了

技术分享图片

 5、不想接口在页面上显示可以使用注解

@ApiIgnore()

 

springboot+swagger2 如何给接口排序

原文:https://www.cnblogs.com/mydotnetforyou/p/11943252.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!