Swagger开发接口的文档在线自动生成

Swagger接口的文档在线自动生成

使用Swagger你只需要按照它的规范去定义接口及接口相关的信息，就可以做到生成接口文档，以及在线接口调试页面。

官网：https://swagger.io/

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

1. 导入 knife4j 的maven坐标

   在pom.xml中添加依赖

1. <dependency>
   
2.       <groupId>com.github.xiaoymin</groupId>
   
3.       <artifactId>knife4j-spring-boot-starter</artifactId>
   
4.    </dependency>

复制代码

完整带版本：

1. <dependency>
   
2.             <groupId>com.github.xiaoymin</groupId>
   
3.             <artifactId>knife4j-spring-boot-starter</artifactId>
   
4.             <version>3.0.2</version>
   
5. </dependency>
   

复制代码

2. 在配置类中加入 knife4j 相关配置

   WebMvcConfiguration.java

1. /**
   
2.      * 通过knife4j生成接口文档
   
3.      * @return
   
4. */
   
5.     @Bean
   
6.     public Docket docket() {
   
7.         ApiInfo apiInfo = new ApiInfoBuilder()
   
8.                 .title("苍穹外卖项目接口文档")
   
9.                 .version("2.0")
   
10.                 .description("苍穹外卖项目接口文档")
    
11.                 .build();
    
12.         Docket docket = new Docket(DocumentationType.SWAGGER_2)
    
13.                 .apiInfo(apiInfo)
    
14.                 .select()
    
15.                 .apis(RequestHandlerSelectors.basePackage("com.sky.controller"))
    
16.                 .paths(PathSelectors.any())
    
17.                 .build();
    
18.         return docket;
    
19.     }

复制代码

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

   WebMvcConfiguration.java

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

复制代码

4. 访问测试

   接口文档访问路径为 http://ip:port/doc.html ---> http://localhost:8080/doc.html

### 5.3 常用注解

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

| **注解**          | **说明**                                 |
| ----------------- | ---------------------------------------- |
| @Api              | 用在类上，例如Controller，表示对类的说明 |
| @ApiModel         | 用在类上，例如entity、DTO、VO            |
| @ApiModelProperty | 用在属性上，描述属性信息                 |
| @ApiOperation     |   用在方法上，例如Controller的方法，说明方法的用途、作用 |


WebMvcConfiguration.zip (1.08 KB, 下载次数: 0, 价格: 1 金钱)

2025-9-13 13:53 上传

点击文件名下载附件

jdk17完整项目参考：
sky-take-out.zip (72.67 KB, 下载次数: 0, 价格: 10 金钱)

2025-9-13 13:57 上传

点击文件名下载附件

Swagger开发接口，我们要实现管理端和用户端接口进行区分
在WebMvcConfiguration.java中，分别扫描"com.sky.controller.admin"和"com.sky.controller.user"这两个包。

@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;
    }