使用knife4j生成接口文档

迟来的正义

已于 2024-04-04 20:54:39 修改

阅读量676

点赞数 14

文章标签： java

于 2024-01-24 12:06:29 首次发布

本文链接：https://blog.csdn.net/d17835810560/article/details/135818779

版权

第一步

导入 knife4j 的maven坐标，在pom.xml中添加依赖

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

第二步

在配置类中加入 knife4j 相关配置（注意修改docket中apis的包名）

@Configuration
@Slf4j
public class WebMvcConfiguration extends WebMvcConfigurationSupport {

@Bean
public Docket docket1() {
    log.info("准备生成接口文档");
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("苍穹外卖项目接口文档")
            .version("2.0")
            .description("苍穹外卖项目接口文档")
            .build();
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .groupName("管理端接口")
            .apiInfo(apiInfo)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.sky.controller.admin"))
            .paths(PathSelectors.any())
            .build();
    return docket;
}

@Bean
public Docket docket2() {
    log.info("准备生成接口文档");
    ApiInfo apiInfo = new ApiInfoBuilder()
            .title("苍穹外卖项目接口文档")
            .version("2.0")
            .description("苍穹外卖项目接口文档")
            .build();
    Docket docket = new Docket(DocumentationType.SWAGGER_2)
            .groupName("用户端接口")
            .apiInfo(apiInfo)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.sky.controller.user "))
            .paths(PathSelectors.any())
            .build();
    return docket;
}
/**
 * 设置静态资源映射
 *
 * @param registry
 */
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
    log.info("开始设置静态资源映射");
    registry.addResourceHandler("/doc.html").addResourceLocations("classpath:/META-INF/resources/");
    registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
}
}

第三步

访问地址：http://localhost:8080/doc.html （我的端口是8080）