Swagger2和Swagger3(OpenAPI3)和Knife4j注解对比

在这里插入图片描述
在这里插入图片描述

Spring Boot 3 只支持OpenAPI3规范,如何部署查看详情帖子
https://blog.csdn.net/Ying_ph/article/details/130644638
参考dome:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo/tree/master/knife4j-spring-boot3-demo
基础使用:Swagger2和OpenAPI3注解对比

在这里插入图片描述

@Tag(name = "user-controller", description = "用户接口")
@RestController
public class UserController {
    
    
   // 忽略这个api
   @ApiIgnore
   @GetMapping("/hello")
   public String hello(){
    
    
       return "hello";
   }
  
   @Operation(summary = "用户接口 - 获取用户详情")
   @GetMapping("/user/detail")
   // 这里的@Parameter也可以不加,Swagger会自动识别到这个name参数
   // 但是加@Parameter注解可以增加一些描述等有用的信息
   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")
   // 这里的user会被Swagger自动识别
   public User addUser(@RequestBody User user){
    
    
       System.out.println("添加用户");
       return user;
   }
}

	/**
     * 保存电影信息
     */
    @Operation(summary = "保存电影信息")
    @Parameters({
    
    @Parameter(name = "typeId",description = "类型id")})
    @GetMapping("/saveMovie/{typeId}")
    public AjaxResult<?> saveMovie(@PathVariable Integer typeId) {
    
    
        Object object = movieInformationUtil.saveMovie(typeId);
        return AjaxResult.success(object);
    }

	/**
     * 登录
     */
    @Operation(summary = "登录")
    @PostMapping("/login")
    public AjaxResult<?> login(@RequestBody LoginReq loginReq) {
    
    }
@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;

}

@Data
@Schema
public class LoginReq implements Serializable {
    
    
    private static final long serialVersionUID = -5091253891513062589L;
    /**
     * 姓名
     */
    @Schema(description = "姓名")
    private String username;
    /**
     * 密码
     */
    @Schema(description = "密码")
    private String password;
    /**
     * 验证码
     */
    @Schema(description = "验证码")
    private String captcha;
}

/**
 * 统一返回类
 */
@Schema
public class AjaxResult<T> {
    
    

    /**
     * 状态码
     */
    @Schema(description = "状态码")
    private Integer code;

    /**
     * 返回内容
     */
    @Schema(description = "返回内容")
    private String msg;

    /**
     * 数据对象
     */
    @Schema(description = "数据对象")
    private T data;

    public AjaxResult(Integer code, String msg, T data) {
    
    
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
}

猜你喜欢

转载自blog.csdn.net/Ying_ph/article/details/134925378