Springboot后端集成Swagger2

简介

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。
官方地址:https://swagger.io/irc/

一、springboot集成Swagger

1.1、导入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger-ui</artifactId>
   <version>2.9.2</version>
</dependency>

1.2、配置Swagger

package com.patrol.config;

import com.google.common.base.Predicates;
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.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;

/**
 * Swagger配置类
 */
@Configuration
@EnableSwagger2
public class Swagger2Config {
    @Bean
    public Docket webApiConfig(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("group1")   //组名
                .apiInfo(webApiInfo())  //API文档信息
                .select()   //筛选要扫描的接口
                //只显示api路径下的页面 
                //例如@GetMapping("/api/test")
                .paths(Predicates.and(PathSelectors.regex("/api/.*")))
                .build();
    }

    private ApiInfo webApiInfo(){
        return new ApiInfoBuilder()
                .title("标题")
                .description("这里写描述")
                .version("版本")
                .contact(new Contact("xxx姓名", "地址", "邮箱"))  //联系人信息
                .build();
    }

   
}

1.3、实体类配置

这个配置根据需要进行配置
就是给实体类添加注释

@ApiModel("用户实体")
public class User {
   @ApiModelProperty("用户名")
   public String username;
   @ApiModelProperty("密码")
   public String password;
}

1.4、接口配置

这个配置根据需要进行配置
就是给接口添加注释

package com.patrol.controller;

import com.patrol.pojo.TaskPoint;
import com.patrol.service.TaskPointService;
import com.patrol.utils.Result;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.*;

import javax.annotation.Resource;
import java.util.List;

@Api(tags = "API标签")
@RestController
@RequestMapping("/api/test")
public class TaskPointController {
    @Resource
    private TaskPointService taskPointService;

   
    @ApiOperation(value = "我的接口")
    @PostMapping("add")
    public String add(@ApiParam("参数注释)@RequestBody User user){
       
            return user.username;
        
    }

  
}

Swagger注解	说明
@Api(tags = “xxx模块说明”)	作用在模块类上
@ApiOperation(“xxx接口说明”)")	作用在接口方法上
@ApiModel(“xxxPOJO说明”))	作用在模型类上：如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)")	作用在类方法和属性上，hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)	作用在参数、方法和字段上，类似@ApiModelProperty

二、启动测试

地址:localhost:port/swagger-ui.html