Swagger2为接口进行排序

声明!声明!声明!如果没有做其他配置的话,按照下方的配置肯定可以用,但是如果有其他配置的话我就不敢保证了,Swagger迭代的挺快的,不同版本之间的配置也略有不同。

第一步:引入依赖

注意:直接复制,不要修改版本

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.9.2</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.21</version>
</dependency>

<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>1.5.21</version>
</dependency>

第二步:写个swagger的配置类

注意:标红的地方自己修改

package com.example.demo.config;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;


/**
 * @author zhaojianjun
 * @data 2021/07/03
 * http://localhost:8899/swagger-ui.html
 * http://localhost:8899/doc.html bootstarp路径
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                //是否开启(true 开启,false()。生产环境建议隐藏)
                .apiInfo(apiInfo())
                .select().apis(RequestHandlerSelectors
                        .basePackage("com.example.demo.web"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //设置文档标题(API名称)
                .title("设备功能接口文档")
                //文档描述
                .description("接口说明")
                //服务条款URL
                .termsOfServiceUrl("http://localhost:8899/")
                //版本号
                .version("1.0")
                .build();
    }

    @Bean
    public CorsFilter corsConfig(){
        final UrlBasedCorsConfigurationSource urlBasedCorsConfigurationSource = new UrlBasedCorsConfigurationSource();
        final CorsConfiguration corsConfiguration = new CorsConfiguration();
        //是否允许请求带有验证
        corsConfiguration.setAllowCredentials(true);
        //允许访问的客户端域名
        corsConfiguration.addAllowedOrigin("*");
        //允许服务端访问的客户端请求
        corsConfiguration.addAllowedHeader("*");
        //允许访问的方法名,GET,POST
        corsConfiguration.addAllowedMethod("*");
        urlBasedCorsConfigurationSource.registerCorsConfiguration("/**",corsConfiguration);
        return new CorsFilter(urlBasedCorsConfigurationSource);
    }

}

第三步:看下图

打开swagger页面http://192.168.31.25:8899/doc.html

 勾选后保存

第四步:看下图

注意画红圈的两个地方,第一个ApiSort是用于为该模块排序,下面那个ApiOperationSupport是用于为该模块下的子接口进行排序。

 接口数量较多,且前端逻辑不太清晰的时候,建议搞开发的按照步骤,为每个接口进行排序,利人利己啊,要不然过个个把月,自己看接口都不知道先走哪个了。


版权声明:本文为m0_54096780原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。