swagger2与knife4j的使用教程

最新推荐文章于 2024-10-12 10:40:20 发布

原创最新推荐文章于 2024-10-12 10:40:20 发布 · 1.5k 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #restful

java随笔专栏收录该内容

24 篇文章

订阅专栏

本文档介绍了如何使用Swagger2和Knife4j来创建和美化前后端交互的API文档。首先，你需要引入Swagger的相关依赖，并配置 SwaggerConfig 类开启文档支持。然后，通过简单的配置，你可以指定公开的接口并忽略特定参数类型。启动服务后，访问 swagger-ui.html 即可查看文档。对于更美观的展示，可以引入Knife4j，它为Swagger提供了增强的界面和功能，只需在配置类上添加@EnableKnife4j注解即可。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swagger2使用

Swagger在前后端交互的时候，提供给前端人员看的文档，具体流程如下：

第一步，导入依赖：

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

第二步，书写配置类(以后用直接拷贝)：

@Configuration
@EnableSwagger2   // 开启swagger文档
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("XXX系统接口文档")
                .version("v1.0")
                .description("XXXXXXXXXXXXXXXXXXXXX")
                .contact(new Contact("张三", "http://localhost:8080/", "222@qq.com"))
                .build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()   // 开始选择公布那些接口
                .apis(RequestHandlerSelectors.basePackage("org.example.controller"))
                .paths(PathSelectors.any())
                .build()
                .ignoredParameterTypes(HttpSession.class, MultipartFile.class, HttpServletRequest.class);  // 忽略掉 HttpSession, MultipartFile, HttpServletRequest.
        return docket;
    }
}

第三步，启动服务器，在浏览器输入：http://localhost:port/swagger-ui.html

knife4j的使用

swagger生成的文档不好看，然后就有了knife4j，他是在swagger的基础上又进行封装，说白了就是加了一层皮。

第一步，导入依赖：

<dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-boot-starter</artifactId>
      <!--在引用时请在maven中央仓库搜索2.X最新版本号-->
      <version>2.0.8</version>
</dependency>

第二步，在swagger的配置类上加上 @EnableKnife4j 注解即可

@Configuration
@EnableKnife4j
@EnableSwagger2   // 开启swagger文档
public class SwaggerConfig {

    @Bean
    public Docket docket() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("XXX系统接口文档")
                .version("v1.0")
                .description("XXXXXXXXXXXXXXXXXXXXX")
                .contact(new Contact("张三", "http://localhost:8080/", "222@qq.com"))
                .build();

        Docket docket = new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo)
                .select()   // 开始选择公布那些接口
                .apis(RequestHandlerSelectors.basePackage("org.example.controller"))
                .paths(PathSelectors.any())
                .build()
                .ignoredParameterTypes(HttpSession.class, MultipartFile.class, HttpServletRequest.class);  // 忽略掉 HttpSession, MultipartFile, HttpServletRequest.
        return docket;
    }
}