你还在用单调的Swagger?还不来试试Knife4j

490 阅读1分钟

简介

Knife4j是Swagger-UI的增强版,以往用Swagger时,它的前端页面始终不够友好,这时出现了一款它的增强版,直接上手,不说废话。

github

MAVEN

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

        //2.0版本以前的UI界面会有所不同
        <!-- https://mvnrepository.com/artifact/com.github.xiaoymin/knife4j-spring-ui -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-ui</artifactId>
            <version>2.0.0</version>
</dependency>

编写配置类

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {


    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                //通过配置化实现开发与生产环境
                .enable(true)
                .apiInfo(new ApiInfoBuilder()
                        .title("knife4j Restful Apis")
                        .description("this is a description")
                        .termsOfServiceUrl("http://localhost:8080/")
                        .contact("justdi@doxmail.com")
                        .version("0.0.1")
                        .build()
                )
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.jl.spring2"))
                .paths(PathSelectors.any())
                .build();
    }


}

效果

访问localhost:8080/doc.html.

  • 主页效果
  • 接口效果

注解还是和Swagger一样,但是看作者打算写一套自己的注解,具体的还要再等等。有了这一套UI看着舒服多了,还能自己调试。

OVER