@ApiOperation注释
时间: 2023-06-12 15:06:27 浏览: 128
swagger 接口文档注释
@ApiOperation是Swagger2框架提供的注释,用于描述API接口的基本信息,包括接口名称、请求方式、请求参数、响应参数等。它可以在API文档中自动生成接口描述信息,并且可以通过Swagger-UI界面进行可视化的展示和测试。在使用Spring Boot开发RESTful接口时,可以使用@ApiOperation注释来描述接口信息,使用方法如下:
```
@ApiOperation(value = "接口名称", notes = "接口描述")
@RequestMapping(value = "/api", method = RequestMethod.GET)
public String api(@RequestParam("param1") String param1, @RequestParam("param2") String param2) {
return "result";
}
```
其中,@ApiOperation注释的value属性表示接口名称,notes属性表示接口描述信息。@RequestMapping注释用于映射请求路径和请求方式。@RequestParam注释用于描述请求参数,其中param1和param2表示参数名,String表示参数类型。最后,api方法返回一个字符串类型的结果。
阅读全文