Knife4j是为Java MVC框架集成Swagger生成Api文档的增强解决方案。

1.导入knife4j的maven坐标

<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j-spring-boot-starter</artifactId>
</dependency>

2,在配置类中加入knife4j相关配置 configurition配置类里面 继承 WebMvcConfigurationSupport 类

/**
 * 通过knife4j生成接口文档
 *
 * @return
 */
@Bean
public Docket docket() {
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("苍穹外卖项目接口文档")
            .version("2.0")
            .description("苍穹外卖项目接口文档")
            .build();
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo).select()
            .apis(RequestHandlerSelectors
            .basePackage("com.sky.controller"))
            .paths(PathSelectors.any())
            .build();

    return docket;
}

3,设置静态资源映射,否则接口文档页面无法访问

/**
 * 设置静态资源映射
 *
 * @param registry
 */
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}

常用注解

通过注解可以控制生成的接口文档，使接口文档拥有更好的可读性，常用注解如下：