Java Springfox环境下Swagger UI Models模块布局自定义咨询

完全可以实现，根据你的需求可以选择两种实现方案：

方案1：仅实现Models板块添加注释的最低需求（无侵入原生方案） #

不需要修改现有配置，直接通过Springfox自带注解给Model添加注释即可：

• 给整个Model类加全局说明：在对应实体类上标注@ApiModel注解，通过description属性填写类的整体说明，示例：

  @ApiModel(description = "用户登录请求参数，带*标识的字段为必填项")
  public class UserLoginReq {
  }
  

• 给Model内字段加单独说明：在实体类属性上标注@ApiModelProperty注解，可配置字段说明、必填状态、示例值等，示例：

  @ApiModelProperty(value = "用户手机号", required = true, example = "13800138000")
  private String phone;
  

加完注解后重启项目，打开Swagger UI的Models板块就能看到对应的注释内容。

方案2：深度调整Models板块布局 #

如果需要修改Models板块的排版、添加自定义公共提示、调整展示逻辑等，可通过覆盖Swagger UI静态资源实现：

1. 从Springfox依赖包中提取Swagger UI的静态资源文件（html、js、css），拷贝到项目的resources/static/swagger-ui（Springfox 3.x）或resources/static（Springfox 2.x）目录下
2. 找到负责渲染Models板块的js逻辑（一般在swagger-ui.min.js的model渲染模块），按照你的需求调整布局代码，也可以直接插入自定义的HTML注释模块
3. 启动项目后，Spring Boot会优先加载本地自定义的静态资源，覆盖依赖默认的Swagger UI页面

内容的提问来源于stack exchange，提问作者Serhii Kachan