一、Swagger接口分类
Spring Boot 2.x中的Swagger接口分为三类:API、Controller和Model。
二、API类
API类是Swagger接口中最基本的类,它定义了接口的基本信息,如接口的名称、描述、参数、返回值等,它是Swagger接口的基础,其他类都是基于它的。它的代码示例如下:
@Api(value = "接口名称", tags = { "接口描述" })public interface Api {@ApiOperation(value = "接口描述")@ApiImplicitParams(value = {@ApiImplicitParam(name = "参数名称", value = "参数描述")})@ApiResponses(value = {@ApiResponse(code = 200, message = "返回值描述")})ResponseEntity<String> 接口名称(String 参数名称);}
三、Controller类
Controller类是对API类的实现,它定义了接口的具体实现,Controller类是Swagger接口的核心,它定义了接口的具体实现,如接口的请求方式、参数处理、返回值处理等,它的代码示例如下:
@RestController@RequestMapping("/controller")public class Controller {@GetMapping("/接口名称")public ResponseEntity<String> 接口名称(@RequestParam("参数名称") String 参数名称) {// 接口实现return ResponseEntity.ok("返回值");}}
四、Model类
Model类是对Controller类的封装,它定义了Controller类的参数和返回值,Model类是Swagger接口的基础,它定义了接口的参数和返回值,如果参数和返回值是复杂类型,则需要定义Model类,它的代码示例如下:
@ApiModel(value = "模型名称")public class Model {@ApiModelProperty(value = "参数名称")private String 参数名称;// getter和setter方法}