SpringBoot 集成 Swagger2

最新推荐文章于 2024-11-05 11:50:27 发布

JourneyRun

最新推荐文章于 2024-11-05 11:50:27 发布

阅读量135

点赞数

分类专栏： SpringBoot 文章标签： java spring

本文链接：https://blog.youkuaiyun.com/qq_41639676/article/details/120759424

版权

SpringBoot 专栏收录该内容

2 篇文章

订阅专栏

本文档详细介绍了如何在SpringBoot项目中集成Swagger2，通过使用Swagger2的注解，如@Api、@ApiOperation等，实现API接口的自动化文档生成。这有助于前后端在开发过程中减少沟通成本，提高效率。步骤包括添加依赖、配置Swagger2、配置YAML文件，并展示了如何访问生成的 Swagger UI 界面。

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

声明：最近搞了一个SpringBoot 项目，前后端分离开发模式，在接口互调中沟通成本有点大，故想找个在线文档供前端开发调用接口使用，减少沟通成本更加专注于后端研发中，从网上参考了各路大神的分享笔记，自己从0集成完成，特此记录一下，希望可以为后续使用备份。

1、@Api：用在请求的类上，说明该类的作用
     tags="说明该类的作用"
     value="该参数没什么意义，所以不需要配置"
示例：
@Api(tags="APP用户注册Controller")

2、@ApiOperation：用在请求的方法上，说明方法的作用
@ApiOperation："用在请求的方法上，说明方法的作用"
    value="说明方法的作用"
    notes="方法的备注说明"
示例：
@ApiOperation(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")

3、@ApiImplicitParams：用在请求的方法上，包含一组参数说明
     @ApiImplicitParams：用在请求的方法上，包含一组参数说明
     @ApiImplicitParam：用在 @ApiImplicitParams 注解中，指定一个请求参数的配置信息       
        name：参数名
        value：参数的汉字说明、解释
        required：参数是否必须传
        paramType：参数放在哪个地方
            · header --> 请求参数的获取：@RequestHeader
            · query --> 请求参数的获取：@RequestParam
            · path（用于restful接口）--> 请求参数的获取：@PathVariable
            · body（不常用）
            · form（不常用）    
        dataType：参数类型，默认String，其它值dataType="Integer"       
        defaultValue：参数的默认值

示列：
@ApiImplicitParams({
    @ApiImplicitParam(name="mobile",value="手机号",required=true,paramType="form"),
    @ApiImplicitParam(name="password",value="密码",required=true,paramType="form"),
    @ApiImplicitParam(name="age",value="年龄",required=true,paramType="form",dataType="Integer")
})


4、@ApiResponses：用于请求的方法上，表示一组响应
     @ApiResponses：用于请求的方法上，表示一组响应
     @ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
        code：数字，例如400
        message：信息，例如"请求参数没填好"
        response：抛出异常的类

示例：
@ApiOperation(value = "select1请求",notes = "多个参数，多种的查询参数类型")
@ApiResponses({
    @ApiResponse(code=400,message="请求参数没填好"),
    @ApiResponse(code=404,message="请求路径没有或页面跳转路径不对")
})

5、@ApiModel：用于响应类上，表示一个返回响应数据的信息
     @ApiModel：用于响应类上，表示一个返回响应数据的信息
            （这种一般用在post创建的时候，使用@RequestBody这样的场景，
            请求参数无法使用@ApiImplicitParam注解进行描述的时候）
     @ApiModelProperty：用在属性上，描述响应类的属性
示例:
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;

@ApiModel(description= "返回响应数据")
public class RestMessage implements Serializable{
 
    @ApiModelProperty(value = "是否成功")
    private boolean success=true;
    @ApiModelProperty(value = "返回对象")
    private Object data;
    @ApiModelProperty(value = "错误编号")
    private Integer errCode;
    @ApiModelProperty(value = "错误信息")
    private String message;
 
    /* getter/setter */
}

swagger2 应有场景：开发环境中前后端前后联调，swagger2 UI 界面解读

swagger2注解使用详细说明

1、

SpringBoot 集成 swagger2

第一步：web 项目pom 问价中引入 swagger jar包

swagger jar 包依赖

<!-- swagger -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.4.0</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.4.0</version>
    </dependency>
</dependencies>

如图示：

第二步：新建 swagger 配置类


import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @author 水上小白龙
 * @date 2021/10/14 9:09
 * @description Swagger2 配置类
 */

@Configuration
@EnableSwagger2
//是否开启swagger，正式环境一般是需要关闭的（避免不必要的漏洞暴露！），可根据springboot的多环境配置进行设置
@ConditionalOnProperty(name = "swagger.enable",  havingValue = "true")
public class Swagger2 {
    // swagger2的配置文件，这里可以配置swagger2的一些基本的内容，比如扫描的包等等
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.jianjing.wjz.controller")).paths(PathSelectors.any())
                .build();
    }
    // 构建 api文档的详细信息函数,注意这里的注解引用的是哪个
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 页面标题
                .title("危急值管理系统")
                // 创建人信息
                .contact(new Contact("水上小白龙","",""))
                // 版本号
                .version("1.0")
                // 描述
                .description("危急值管理系统接口API")
                .build();
    }
}

第三步：配置 application.yml 文件是否启用 swagger