SpringBoot整合Swagger

2020-10-15

1. 引入依赖

<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>

2. 编写配置文件

SwaggerConfig.java

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    /**
     * 创建swagger ui的摘要
     * @return
     */
    @Bean
    public Docket docket() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // 扫描的class的包路径
                .apis(RequestHandlerSelectors.basePackage("demo.srammy.springbootwithswagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * swagger ui的标题信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("用户系统")
                .description("API文档")
                .version("1.0")
                .build();
    }
}

3. 在controller中进行配置

常用注解：

@Api()用于类：标识被标注的类是swagger资源
@ApiOperation()用于方法：表示一个http请求的操作
@ApiParam()用于方法，参数，字段说明：添加参数的元数据，例如参数说明或该参数是否是必填等
@ApiModel()用于类：对类进行说明，在请求参数使用实体类接收时使用
@ApiModelProperty()用于方法，字段：对model属性的说明或者数据操作更改
@ApiIgnore()用于类，方法，方法参数：被标记的方法或者类被忽略
@ApiImplicitParam() 用于方法：表示单独的http请求参数
@ApiImplicitParams() 用于方法：里面可以包含多个 @ApiImplicitParam

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @ApiOperation(value ="查询所有用户:/all",notes ="查询所有用户",httpMethod = "GET")
    @GetMapping(value = "/all")
    public List<User> getAllUsers() {
        return userService.getAllUsers();
    }

    @ApiOperation(value ="查找用户:/findUserById",notes ="根据ID查找用户",httpMethod = "GET")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id",value = "用户ID",paramType = "query",required = true,dataType = "Integer"),
    })
    @GetMapping(value = "/findUserById")
    public User findUserById(@RequestParam Integer id) {
        return userService.findUserById(id);
    }

}

4. 在浏览器中查看

在浏览器地址栏输入http://localhost:8089/swagger-ui.html，这里的8089端口是在properties配置文件中配置的

参考

https://blog.csdn.net/wyb880501/article/details/79576784