Swagger

weixin_52621757

已于 2023-08-16 20:24:25 修改

阅读量66

点赞数 4

文章标签： java

于 2023-08-16 20:12:18 首次发布

本文链接：https://blog.csdn.net/weixin_52621757/article/details/132326705

版权

本文介绍了如何使用Knife4j框架在SpringMVC项目中集成Swagger，以生成API接口文档，提高前后端开发协作效率，同时提供了在线测试入口。通过添加依赖、配置类和使用特定注解，开发者可以轻松实现接口文档的自动生成和静态资源映射。

摘要由CSDN通过智能技术生成

1、介绍

一个用于生成在线API接口文档的小框架

2、作用

①便于前后端开发人员协同开发

②提供在线测试入口，功能类似于Postman

3、Knife4j

SpringMVC集成Swagger，生成API接口文档的增强方案，已经被Spring官方集成

4、使用

4.1、导入依赖

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

4.2、配置类

WebMvcConfiguration

① Swagger

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

②静态资源映射

/**
     * 设置静态资源映射
     * @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/");
}