springboot+swagger2 如何給接口排序


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()

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM