1.常用注解
@Api:主要在类上使用,说明该类作用。可以标识一个controller类作为swagger文档资源来使用。与 controller注解同时使用。
@Api(value = “/user”, description = “Operations about user”)
@Api(tags = “实现user各种操作”)
@ApiOperation:一般在方法上使用,说明方法的作用,每一个url资源的定义。
@ApiOperation( value = “Find purchase order by ID”, notes = “For valid response try integer ID with value <= 5 or > 10. Other values will generated exceptions”, response = Order, tags = {“Pet Store”})
@ApiOperation(value = “实现查询功能”,notes = “实现查询功能”)
notes(接口描述) value(接口名称)只有value可以省略不写
@ApiParam:请求属性 修饰参数,为参数加说明
public R delete(@ApiParam(“参数id”) int id)
@ApiResponse:是响应配置。
@ApiResponse(code=“200”,message=“响应成功”)
@ApiResponses:响应集配置,在其中配置单个@ApiResponse
@ApiResponses({@ApiResponse(code = “200”), message = “响应成功”,@ApiResponse(code = “400”), message = “响应失败”,})
package com.example.springboot01.com.qfedu.controller;import com.example.springboot01.com.qfedu.entity.User;import com.example.springboot01.com.qfedu.service.intf.UserSerivce;import com.example.springboot01.com.qfedu.vo.R;import io.swagger.annotations.*;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.web.bind.annotation.GetMapping;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;@RestController@RequestMapping("/api/user")@Api(tags = "实现user各种操作")public class UserController {@Autowiredprivate UserSerivce serivce;@GetMapping("/selectAll")@ApiOperation(value = "实现查询功能",notes = "实现查询功能")public R selectAll(){return serivce.selectAll() ;}@GetMapping("/insert")public R insert(User user){return serivce.insert(user);}@GetMapping("/delete")public @ApiResponse(code = 200,message ="删除成功") R delete(@ApiParam("参数id") int id){return serivce.delete(id);}@GetMapping("/update")public R update(User user){return serivce.update(user);}}
