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 = “响应失败”,})

  1. package com.example.springboot01.com.qfedu.controller;
  2. import com.example.springboot01.com.qfedu.entity.User;
  3. import com.example.springboot01.com.qfedu.service.intf.UserSerivce;
  4. import com.example.springboot01.com.qfedu.vo.R;
  5. import io.swagger.annotations.*;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.web.bind.annotation.GetMapping;
  8. import org.springframework.web.bind.annotation.RequestMapping;
  9. import org.springframework.web.bind.annotation.RestController;
  10. @RestController
  11. @RequestMapping("/api/user")
  12. @Api(tags = "实现user各种操作")
  13. public class UserController {
  14. @Autowired
  15. private UserSerivce serivce;
  16. @GetMapping("/selectAll")
  17. @ApiOperation(value = "实现查询功能",notes = "实现查询功能")
  18. public R selectAll(){
  19. return serivce.selectAll() ;
  20. }
  21. @GetMapping("/insert")
  22. public R insert(User user){
  23. return serivce.insert(user);
  24. }
  25. @GetMapping("/delete")
  26. public @ApiResponse(code = 200,message ="删除成功") R delete(@ApiParam("参数id") int id){
  27. return serivce.delete(id);
  28. }
  29. @GetMapping("/update")
  30. public R update(User user){
  31. return serivce.update(user);
  32. }
  33. }