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

Swagger示例参数值

马欣荣
2023-03-14

我想在我的Swagger-ui界面上修改数据类型下的示例值。目前它包含以下默认值(由Swagger生成):

"user":{
        "birth":null,
        "nationality":null,
        "lastname":null,
        "firstname":null,
        "identity":null
     }

我想指定实数值,而不是“空”值。PS:我用带注释的spring boot:@ API operation,...

共有1个答案

楚浩然
2023-03-14

然后,您必须为bean中的所有属性插入@ApiModelProperty anotation。然后在里面放一个示例属性。假设您的用户映射到User.java类,因此您将拥有:

public class User {

    @ApiModelProperty(value = "The birthdate", example = "1985-12-07", format= "yyyy-MM-dd")
    private String birth;
 类似资料:
  • 我制作了第一个swagger api规范,dredd给出了错误: 因此,我为参数提供了默认值,现在收到来自dredd的警告: 我想在规范中给出示例ID,但我无法在Swagger规范中找到如何。 我的狂妄自大:

  • 我正在使用Swagger来记录REST API。 我正在上这样的课: 我目前正在使用@Api的含义参数设置dataType为Source.class,但我有多个POST请求,将JSON作为主体参数,比方说,其中的一个变量,例如: 由于前面设置了dataType,Swagger UI显示的示例值是一个完整的Source。类,类似于: 我能以某种方式为这些请求的每个请求切掉Swagger UI显示的示

  • 我正在使用和来记录WebApi2项目。我有一个使用XML正文并返回文本响应的操作。我希望留档包含XML输入的示例-例如

  • 我已经将swagger与django rest框架集成在一起,但是swagger文档没有创建一个输入框来发布post请求的数据。 我的解析器设置, }

  • 我们的业务希望创建一个大摇大摆的文档来表示内部服务器。 由于各种原因,每个请求都需要包括一系列无关的头参数: 如果不包括参数,但参数本身与正在发出的请求无关,服务器将拒绝该请求。 Swagger文档的主要目的是生成少量客户机应用程序(我们控制所有这些应用程序)来与服务器交互。 我们可以在每个请求上显式地添加每个参数,但这将导致文档中的重复和客户端中的额外处理。或者,我们可以将这些参数视为元数据,并

  • 在一个基于NodeJS的项目中,loopback-component-explorer(2.7.0)附带的Swagger没有显示HTML页面中的“参数”,我们可以在其中为Restendpoint提供所需的params,而不管http动词(例如GET、POST和PATCH等)。必须remoteMethod(...)定义遵循一些大摇大摆的要求吗? 谢了。