SpringBoot整合swagger接口文档

SpringBoot整合swagger

SpringBoot整合swagger的步骤很简单，一共分为四步即可

1.pom.xml配置

将以下代码放到pom.xml的《dependencies》标签下并从新运行maven

<!--swagger配置-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.6.1</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.6.1</version>
        </dependency>

2.构建swagger配置类

在config文件下创建Swagger类

在该类中填入以下代码

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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/***
 * swagger接口文档配置类
 */
@Configuration
@EnableSwagger2
public class Swagger {

    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yh.king.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    public ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("利用swagger2构建的API文档")
                .description("用restful风格写接口")
                .termsOfServiceUrl("")
                .version("1.0")
                .build();
    }
}

这里必须需要做修改的地方是basePackage里面的路径，该路径需要指定到自己controller文件夹的位置

3.Swagger的简单使用

直接上代码

import com.yh.king.model.auto.UmsRole;
import com.yh.king.service.IUmsRoleService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponse;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RestController;

import java.util.List;

/**
 * <p>
 * 后台用户角色表 前端控制器
 * </p>
 *
 * @author astupidcoder
 * @since 2020-08-12
 */
@RestController
@RequestMapping("/umsrole")
@Api(value = "用户角色类")
public class UmsRoleController {

    @Autowired
    private IUmsRoleService umsRoleService;

    @GetMapping("/getUmsPole")
    @ApiOperation(value = "获取所有用户角色信息",notes = "返回角色List")
    public List<UmsRole> getUmsRole(){
        return umsRoleService.list();
    }
}

上方代码使用了两个Swagger注解
@Api ：在类上定义
@ApiOperation：在接口方法上定义
在这里我只做了简单的使用，具体的注解使用方法可以参照官网
Swagger官网

4.查看效果

运行SpringBoot
访问http://localhost:8081/swagger-ui.html
当看到如下图截图即配置成功