SpringBoot整合Swagger

最新推荐文章于 2023-12-05 14:20:30 发布

原创最新推荐文章于 2023-12-05 14:20:30 发布 · 70 阅读

0 ·

CC 4.0 BY-SA版权

本文介绍了如何在SpringBoot项目中集成Swagger，包括引入依赖、配置类设置、API注解使用，以及如何通过Swagger UI进行接口文档的查看。示例展示了用户API接口的创建和验证过程。

SpringBoot简单整合Swagger，会陆陆续续的继续完善

SprngBoot整合Swagger步骤

引入依赖

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

编写配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.wx.springboottest.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("SpringBoot整合Swagger")
                        .description("SpringBoot整合Swagger，详细信息......")
                        .version("9.0")
                        .contact(new Contact("啊啊啊啊","blog.youkuaiyun.com","aaa@gmail.com"))
                        .license("The Apache License")
                        .licenseUrl("http://www.baidu.com")
                        .build());
    }
}

加上注解

@RestController
@Api(tags = "user的API接口")
@RequestMapping("/user")
public class UserController {
@PostMapping("/insert")
    @ApiOperation("插入用户接口")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "name", value = "姓名", defaultValue = "lisi"),
            @ApiImplicitParam(name = "age", value = "年龄", defaultValue = "18")
    })
    public String insert(@RequestBody @Valid User user, BindingResult bindingResult){
        String s="";
        if (bindingResult.hasErrors()){
            List<ObjectError> allErrors = bindingResult.getAllErrors();
            for (ObjectError error : allErrors) {
                String name = error.getObjectName();
                String message = error.getDefaultMessage();
                s+=name+message;
            }
        }else {
            userService.inserUser(user);
            s = "插入成功";
        }
        return s;
    }
}

bean加上注解

@Data
@ApiModel
@TableName(value = "user")
public class User {

    @TableId(value = "id", type = IdType.ID_WORKER_STR)
    @ApiModelProperty(value = "主键id")
    private String id;

    @NotBlank(message = "姓名不能为null")
    @ApiModelProperty(value = "姓名")
    private String name;

    @NotNull
    @ApiModelProperty(value = "年龄")
    @Min(value = 0, message = "age必须大于0")
    private Integer age;
}