Springboot之swagger-bootstrap-ui(knife4j)

海加尔金鹰

发布于 2020-06-09 10:36:28

1.1K0

发布于 2020-06-09 10:36:28

文章被收录于专栏：海加尔金鹰的专栏

最近在网上看到一个比较好的swagger-ui,swagger自带的UI不是很友好。特此记录下整合过程，并梳理下swagger相关的知识

什么是swagger?

简单来说就是解放程序员，让程序员少些不必要的API文档，只需要在项目当中定义好接口，返回实体等然后通过swagger暴露出来就可以自动生成接口相关的API文档！！！

swagger-bootstrap-ui(knife4j)

swagger是由自己自带的UI的，不过在对比两个之后，感觉swagger-bootstrap-ui现已变更为knife4j很不错！！！knife4j官网第一步：引入JAR包

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>2.0.3</version>
        </dependency>

第二步：代码开启swagger2支持

@Configuration
@EnableSwagger2 
public class Swagger2Configuration {


    @Bean
    public Docket createRestApi() {

        List<Parameter> pars = new ArrayList<Parameter>();
  
        //构建默认参数
        ParameterBuilder ticketPar = new ParameterBuilder();
        ticketPar.name("Content-Type").description("Content-Type")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(true)
                .defaultValue("application/json").build();
        pars.add(ticketPar.build());
        //构建默认请求验证参数
        ticketPar = new ParameterBuilder();
        ticketPar.name("Authorization").description("Authorization")
                .modelRef(new ModelRef("string")).parameterType("header")
                .required(true)
                .defaultValue("111111111111111111111111111111111111111111111111").build();
        pars.add(ticketPar.build());
  
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("cn.hjljy.fastboot.controller"))
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars);
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger RESTful APIs")
                .description("swagger RESTful APIs")
                .termsOfServiceUrl("http://www.hjljy.cn/")
                .contact("hjljy@outlook.com")
                .version("1.0")
                .build();
    }


}

第三步：创建一个Controller接口，然后输入：127.0.0.1:8080/doc.html 然后就可以在浏览器当中看到接口数据了。