Spring Boot 中使用 Swagger( 二 )

接口的形参为 User 实体对象示例:
@Data@NoArgsConstructor@AllArgsConstructor@ApiModel(value = "https://www.huyubaike.com/biancheng/User 对象",description = "?户/买家信息")public class User { @ApiModelProperty(dataType = "int",required = false)private int userId;@ApiModelProperty(dataType = "String",required = true, value = "https://www.huyubaike.com/biancheng/?户注册账号")private String userName;@ApiModelProperty(dataType = "String",required = true, value = "https://www.huyubaike.com/biancheng/?户注册密码")private String userPwd;@ApiModelProperty(dataType = "String",required = true, value = "https://www.huyubaike.com/biancheng/?户真实姓名")private String userRealname;@ApiModelProperty(dataType = "String",required = true, value = "https://www.huyubaike.com/biancheng/?户头像url")private String userImg;}

  • @ApiIgnore:接??法注解,添加此注解的?法将不会?成到接??档中
  • swagger-ui 插件
    发现一个规律,越学到最后,越是有惊喜,有不有?
    swagger-ui 插件是一款 UI 美化插件,是基于 swagger 的 。
    之前使用的默认 swagger 文档和调试页面如果使用起来不太顺畅 , 可以试试这款 swagger-ui 插件 。
    使用
    1. 添加依赖
      <dependency><groupId>com.github.xiaoymin</groupId><artifactId>swagger-bootstrap-ui</artifactId><version>1.9.6</version></dependency>
    2. 【Spring Boot 中使用 Swagger】重启 SpringBoot 应用,访问 http://localhost:8080/doc.html
      效果如下:
      Spring Boot 中使用 Swagger

      文章插图

      Spring Boot 中使用 Swagger

      文章插图

      Spring Boot 中使用 Swagger

      文章插图
    还等什么,赶紧装插件去~

    推荐阅读