微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何自定义请求主体的示例值并使用springdoc-open-api在swagger-ui上执行

如何解决如何自定义请求主体的示例值并使用springdoc-open-api在swagger-ui上执行

我已经使用springboot创建了rest webservice 并添加了springdoc-open-api,用于调试Web服务, 现在我有2个问题

1-如何在swagger-ui文档页面显示的请求中添加自定义测试值?

2-如何在swagger-ui文档页面上单击TRY IT OUT按钮执行请求?

有关其余的Web服务,请参考以下代码段:

@PostMapping(value="/result",consumes={ "application/json"},produces={ "application/json" } )
@Parameter(description  = "Student object need to calculate the score",name="InputObject",required = true )
public ResponseEntity<Result> displayResult(@Valid  @RequestBody Student request);

Public class Student{
  String name;
  String birthDate;
  String motherName;
  int rollNo;
  int seatNo;
}

Public class Result{
  int marks;
  String grade;
  double percentage;
}

I have tried to add value of request using @Schema(name = "name",example= "Rubeena",description = "Name of student"),is it right way to add the value in example request ?
Even after adding this schema when i click on TRY IT OUT button i dont get the outcome.

Is there any way to solve this problem?

解决方法

使用@Schema批注,我可以在示例请求中提供值

Public class Student{
@Schema(example= "XXX",description = "Name of student")
 String name;

@Schema(示例=“ 10-10-2020”,描述=“学生的出生日期”) 字符串birthDate; ...... }

,

在dto类中使用@ApiModelProperty注释。

示例-

scale_fill_discrete(labels = c('-O2','+O2'))

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。