swagger应用

创建项目

创建springboot项目

引入依赖

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

 配置swagger2

创建config文件夹，并在其下创建 Swagger2Config，在类上添加注解

@Configuration和 @EnableSwagger2，具体配置如下

 

@Configuration
@EnableSwagger2
public class Swagger2Config {

    @Bean
    public Docket createRestApi(Environment environment) {
        //检测环境
        Profiles profiles = Profiles.of("dev","test");
        boolean flag = environment.acceptsProfiles(profiles);
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //是否开启swagger
                .enable(flag)
                .groupName("cong")
                .select()
                //扫描指定包中的swagger注解
                .apis(RequestHandlerSelectors.basePackage("com.cong.controller"))
                //扫描所有有注解的api，用这种方式更灵活
//                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("swagger应用")
                .description("swagger应用API接口文档")
                .termsOfServiceUrl("https://blog.csdn.net/cong_r_cong")
                .license("1281637125@163.com")
                .version("1.0.0")
                .build();
    }


}

运行结果

controller

controller上增加@Api注解

@Api(value = "用户Controller", tags = { "用户访问接口" })

method()上新增@ApiOperation

@ApiOperation(value = "注册用户")

参数前增加注解@ApiParam
例如：
@ApiParam("用户实体对象") @RequestBody User user

/**
 * 新增（注册）用户
 * @param user 新增（注册）用户的信息
 * @return
 */
@PostMapping("/saveUser")
@ResponseBody
@ApiOperation(value = "注册用户")
public Object saveUser(@ApiParam("用户实体对象") @RequestBody User user){
    String phone = user.getPhone();
//判断电话号码是否为空
    if(phone == null || phone ==""){
        return new Result(CodeMsg.USER_PHONE_NOT_NULL);
    }
//判断密码是否为空
    if (user.getPassword() == null || user.getPassword() == ""){
        return new Result(CodeMsg.USER_PASSWORD_NOT_NULL);
    }

    if(!flag){
        return new Result(CodeMsg.USER_CODE_ERROR);
    }
//判断用户是否存在
    boolean flag = iUserService.getUserByPhone(phone);

    if(flag){
        iUserService.saveUser(user);
        return new Result();
    }else{

        return new Result(CodeMsg.USER_LOGIN_NAME_EXIST_ERROR);
    }

}

pojo

类上加入@ApiModel

@ApiModel(value = "User", description = "用户实体类")