当前位置: 首页 > 知识库问答 >
问题:

Swagger -定制示例请求体

柴瀚昂
2023-03-14

我有一个用于POST操作的大摇大摆的Spring MVCendpoint。该操作采用一个路径参数和一个(json)请求实体。当大摇大摆的UI生成时,它会自动创建请求正文数据类型的示例值。这个例子是基于应用程序中的一个java实体。该实体用于一些其他操作,但是对于POST操作,我不希望示例中暴露的一些实体字段。是否可以在不修改现有java模型的情况下修改这个例子?例如,是否可以在下面的示例lastUpdate中排除。

共有1个答案

班高明
2023-03-14

是的,可以使用jackson注释忽略示例值中的<code>lastUpdate</code>,JsonIgnore</code>。

import com.fasterxml.jackson.annotation.JsonIgnore;    

public class Phone {
  private String phoneNumber;
  private String lastUpdate;
  private int status;

  public String getPhoneNumber() {
    return phoneNumber;
  }
  public void setPhoneNumber(String phoneNumber) {
    this.phoneNumber = phoneNumber;
  }

  @JsonIgnore
  public String getLastUpdate() {
    return lastUpdate;
  }
  public void setLastUpdate() {
    this.lastUpdate = lastUpdate;
  }

  public int getStatus() {
    return lastUpdate;
  }
  public void setStatus() {
    this.status = status;
  }
}
 类似资料:
  • 我已经将Swagger(OpenAPI)与Spring Webflux集成,如下所述:https://springdoc.org/#spring-weblfuxwebmcfn-with-functional-endpoints using routeroperation。集成工作良好,可以在/swagger-ui.html访问 添加RouterOperations注释后,我可以看到swagger-

  • 我正在用Swagger创建一个API文档。我直接尝试了openapi 3.0。不知何故,我无法得到我的请求机构工作的描述。 但这些描述不会出现: 我想得到像《大摇大摆2》那样的东西。下面是如何将相同的代码转换为Swagger 2

  • 我的Symfony 4应用程序中有一个APIendpoint,我想用NelmioApiDocBundle和Swagger记录它。endpoint将JSON作为请求数据,并返回一些自定义JSON作为响应。如何使用注释将其示例添加到文档中?我在文档页面上看不到任何示例,只有描述。

  • 是否可以生成一个包含application/json和x-www-form-urlencoded请求体示例的招摇过市UI页面(以及redoc)?我可以得到application/json的示例,但在swagger/redoc UI中选择x-www-form-urlencoded作为请求类型时却没有。 我将以下装饰器用于“create”方法(在ModelViewSet中) 其中 MySerializ

  • 本文向大家介绍Ajax请求内嵌套Ajax请求示例代码,包括了Ajax请求内嵌套Ajax请求示例代码的使用技巧和注意事项,需要的朋友参考一下 前段时间做项目,需要把全国省市的两个XML文件整合成一个JSON格式的数据,手写的话觉得数据太多了,而且容易出错,于是就想到了用Ajax嵌套的方法来解决,就想平时用Ajax的方法直接嵌套,都会先读出外面Ajax的内容,然后才读取嵌套在Ajax里面的内容,后面经

  • 本文向大家介绍JSP中的AJAX请求-示例,包括了JSP中的AJAX请求-示例的使用技巧和注意事项,需要的朋友参考一下 AJAX是一个异步请求,通常在不同的网站中用于加载内容而不刷新整个页面。例如,您可以看到cricinfo,它将自动动态更新,而无需刷新页面,发送到服务器的请求无需任何重新加载。 index.jsp 在这里,我们从用户那里获取输入,并通过创建HttpRequest对象将它们发送到服