Spring Boot 整合 Swagger

文章目录

Spring Boot 整合 Swagger

Swagger 简介

1.为什么要用Swagger

在平时开发中，一个好的API文档可以减少大量的沟通成本，还可以帮助新加入项目的同事快速上手业务。大家都知道平时开发时，接口变化总是很多，有了变化就要去维护，也是一件比较头大的事情。尤其是现在前后端分离情况，更容易造成文档和代码不一致。这时，我们可以通过Swagger2来使接口规范，方便维护。

2.Swagger简介

Swagger是一款Restful接口的文档在线自动生成和功能测试功能软件。
Swagger是一个规范和完整的框架，用于生成、描述、调用和可视化Restful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。

步骤：

1.添加Swagger2的依赖

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

2.添加Swagger配置类

在这里插入图片描述

配置类建议放在 config 包下，config 包如图所示
注意：启动类放在所有包外（这样才能自动扫描到其他的包下的组件）

/**
 * swagger2 配置类
 * @Author ldd
 * @Create 2022-03-10 14:55
 */
@Configuration
public class Swagger2Config {

    /**
     *  创建API应用
     *  apiInfo() 增加API相关信息
     *  通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现，
     *  本例采用指定扫描的包路径来定义指定要建立API的目录。
     * @return
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("edu.ustb.controller"))//扫描服务的包
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * 访问地址：http://项目实际地址/swagger-ui.html
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("时序逻辑检查 API 文档")
                .description("时序逻辑检查 API 接口")
                .termsOfServiceUrl("http://localhost:8081")
                .version("1.0")
                .build();
    }

}

配置类记得加 @Configuration 注解，不然无法被启动类扫描到，即不起作用

3.启动类添加注解

启动类添加 @EnableSwagger2 的注解
@EnableSwagger2 的作用是启用Swagger2相关功能

@SpringBootApplication
@EnableSwagger2
public class CheckApplication {
    public static void main(String[] args) {
        SpringApplication.run(CheckApplication.class, args);
    }
}

4.Controller中添加其余Swagger注解，便于在网页端显示

@Api(value = "时序逻辑检查")
@RestController
public class AndOrNotController {

    // 日志对象
    private Logger logger = LoggerFactory.getLogger(getClass());

    @ApiOperation(value = "时序逻辑表达式检查")
    @GetMapping("/handleAndOrNot")
    public boolean handleAndOrNot(@ApiParam(name = "andOrNotExpressionId", value = "时序逻辑表达式Id")
                                              @RequestParam String andOrNotExpressionId) {
        AndOrNotHandler andOrNotHandler = new AndOrNotHandler();
        boolean result = andOrNotHandler.handlerAndOrNotById(andOrNotExpressionId);
        logger.info("检查结果 ----> {}", result);
        return result;
    }
}

Swagger 的注解放在了文末

5.启动项目测试

在这里插入图片描述

Swagger注解详解：

@Api：用在请求的类上，表示对类的说明
    tags="说明该类的作用，可以在UI界面上看到的注解"
    value="该参数没什么意义，在UI界面上也看到，所以不需要配置"

@ApiOperation：用在请求的方法上，说明方法的用途、作用
    value="说明方法的用途、作用"
    notes="方法的备注说明"

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

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

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

1. @Api：用在请求的类上，说明该类的作用

示例：

@Api(tags="APP用户注册Controller")

2. @ApiOperation：用在请求的方法上，说明方法的作用

示例：

@ApiOperation(value="用户注册",notes="手机号、密码都是必输项，年龄随边填，但必须是数字")

3.@ApiImplicitParams：用在请求的方法上，包含一组参数说明

示例：

@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：用于请求的方法上，表示一组响应

示例：

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

5.@ApiModel：用于响应类上，表示一个返回响应数据的信息

示例:

@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 */
}