Swagger2和Swagger3对比
swagger2 | OpenAPI | 注解位置 |
---|
@Api | @Tag(name = “接口类名”,description = “接口类描述”) | Controller 类上 |
@ApiOperation | @Operation(summary =“接口方法描述”) | Controller 方法上 |
@ApiImplicitParams | @Parameters | Controller 方法上 |
@ApiImplicitParam | @Parameter(description=“参数描述”) | Controller 方法上 @Parameters 里 |
@ApiParam | @Parameter(description=“参数描述”) | Controller 方法的参数上 |
@ApiIgnore | @Parameter(hidden = true) 或 @Operation(hidden = true) 或 @Hidden | - |
@ApiModel | @Schema | DTO类上 |
@ApiModelProperty | @Schema | DTO属性上 |
测试用例:
@Tag(name = "user-controller", description = "用户接口")
@RestController
public class UserController {
@ApiIgnore
@GetMapping("/hello")
public String hello(){
return "hello";
}
@Operation(summary = "用户接口 - 获取用户详情")
@GetMapping("/user/detail")
public User getUser(@Parameter(in = ParameterIn.QUERY, name = "name", description = "用户名") String name){
User user = new User();
user.setUsername(name);
user.setPassword("123");
return user;
}
@Operation(summary = "用户接口 - 添加用户")
@PostMapping("/user/add")
public User addUser(@RequestBody User user){
System.out.println("添加用户");
return user;
}
}
实体类:
@Schema
@Data
public class User {
@Schema(name = "username", description = "用户名", defaultValue = "javalover", example = "javalover")
private String username;
@Schema(name = "password", description = "密码", defaultValue = "123456", example = "123456")
private String password;
@Schema(hidden = true)
private String email;
}