Knife4j是swagger的增强方案

我会带着你远行 2022-10-15 08:56 244阅读 0赞

Knife4j是swagger的增强方案，可以比swagger更友好地显示接口文档。  
接口界面如下：

UI访问地址：http://localhost:8088/doc.html

项目依赖  
内部已集成 io.springfox

com.github.xiaoymin knife4j-spring-boot-starter 2.0.0

配置类  
需要配置接口的附带信息，如作者等。

@Configuration //配置  
@EnableSwagger2 //开启Swagger2  
@EnableKnife4j //开启Knife4j  
@Import(BeanValidatorPluginsConfiguration.class)  
@ConditionalOnProperty(value = \{“knife4j.enable”\}, matchIfMissing = true)  
public class Swagger2Config \{

/**
     * 资源API分组
     *
     * @return Docket
     */
    @Bean(value = "sourceApi")
    public Docket sourceApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("资源Api")
                //输入方法
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(SwaggerSourceApi.class))
                .paths(PathSelectors.any())
                .build();
    
    }
    /**
     * 账号API分组
     *
     * @return Docket
     */
    @Bean(value = "userApi")
    public Docket userApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("账户Api")
                .apiInfo(apiInfo())
                .select()
                //api接口筛选：所有有RequestMapping注解的方法
                .apis(RequestHandlerSelectors.withClassAnnotation(SwaggerUserApi.class))
                .paths(PathSelectors.any())
                .build();
    }
    
    
    //Api输出
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("轻语资源站API文档")
                .description("包含账户管理相关的Api")
                .termsOfServiceUrl("http://localhost:8088/")
                .contact(new Contact("jun665", "#", "2476545423@qq.com"))
                .version("1.0")
                .build();
    }

注意上方SwaggerUserApi和SwaggerSourceApi是我自定义注解，通过注解进行分组。如果不想使用，修改使用注解的方法即可

//资源api注释  
@Target(ElementType.TYPE)  
@Retention(RetentionPolicy.RUNTIME)  
@Api(tags = “资源管理api”)  
public @interface SwaggerSourceApi \{  
\}

//用户Api注释  
@Target(ElementType.TYPE)  
@Retention(RetentionPolicy.RUNTIME)  
@Api(tags = “账号管理Api”)  
public @interface SwaggerUserApi \{  
\}

至此knife4j已经配置完成了，需要在接口上添加swagger注解，就能显示出信息。用法和swagger一样。