java - Swagger @ApiModelProperty 基于 HTTP 请求的灵活性

标签 java spring-mvc swagger springfox

我在 Pojo 的字段上使用 Swagger @ApiModelProperty 并使用 SpringFox 来自动生成文档。这是一个示例 pojo:

public class Pojo {
 @ApiModelProperty(value =" some id", hidden = true)
 private final String id;
}

我有一个接收 Pojo 的端点,该端点可以是/endpoint。该端点上有 PUT 和 POST 动词。有没有办法使用 Swagger Annotation 或 SpringFox Docket 配置在 POST 上隐藏文档中的字段“id”,但在 PUT 上让该字段显示在文档上。

我宁愿不必创建一个重复的 Pojo 类,这样我就可以注释要隐藏的字段。

最佳答案

我不认为这是直接可能的,但也许你可以通过其他方式解决它?这里有几个替代方案:

  1. 创建两个 POJO,但其中一个使用 id 字段扩展另一个 POJO。
  2. POSTPUT 使用相同的 POJO,但以 @PathVariable 的形式将 id 字段添加到 PUT

关于java - Swagger @ApiModelProperty 基于 HTTP 请求的灵活性,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/53859925/

相关文章:

java - 一个 Web 应用程序中的 Spring MVC 和 Spring WS 调度程序 Servlet 配置

spring - 放置在文件夹中时找不到 MessageSource 的 ResourceBundle

java - Spring事务与restful应用程序

json - Swagger 文档中的驼峰命名法

java - Springfox Bean Validations @Size 注释在列表上无法正常工作

ArrayList 中的 Java 对象方法

java - JLabel 未添加到 JPanel

java - 显示点击的特定链接的数据

java - 从 jsp 中的 ModelAndView 检索模型

node.js - 将 yaml 文件作为引用包含在另一个 yaml 文件 swagger 中