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

Springdoc Openapi -添加响应示例值

陆昕
2023-03-14

我正试图将示例响应值添加到我的springdoc-openapi swagger文档中。

比如用“马克吐温”代替“字符串”等。

我尝试使用这个解决方案-springdoc openapi:如何添加POST请求示例?

我已经在课堂上使用org.springframework.web.bind.annotation.RequestBody了。

如果我使用这个-
@io.swagger.v3.oas.annotations.parameters.RequestBody(内容=@Content(示例={@示例对象(name="Person example",摘要="人示例",value="{"email":test@gmail.Com,""firstName":"josh",""lastName":"Spring...""}")}))

我得到以下的借口 -

输入 ',@io.swagger.v3.oas.annotations.parameters.RequestBody(content=@Content(examples={@ExampleObject(name=“Person sample”,summary=“person example”,value=“{\”email\“: test@gmail.Com,” “\”firstName\“: \”josh\“,” “\”lastName\“: \”spring...\“” “}”)})))': NoViableAltException

任何人都可以给我一个解决方案吗?

共有1个答案

鲁阳焱
2023-03-14

这对我有用

@Schema( type = "string", example = "Clark Kent")
private String name;
 类似资料:
  • API的返回(响应)结果为 JSON 结构,这是一个 getSalesAmount 的API请求返回: { "code": 1000, "msg": "OK", "data": { "action": "getSalesAmount", "sales_amount": [ { "time

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

  • 我正在实现一个简单的JavaRMI应用程序。它的主要目标是加2个整数。代码源如下:客户端和服务器端的AdditionInterface

  • 添加示例到Sandcastle在cesium编程入门(七)3D Tiles,模型旋转中提到过,这里是一份完整的说明 创建例子 开启node服务后打开 http://localhost:8080/Apps/Sandcastle/ 会自动跳到 hello world 示例 可以选择点击左上角的【New】按钮新建一个页面,也可以就在当前页面的【JavaScript code】面板中进行修改 如果需要添加

  • 我非常确定“Expires”是有效的HTTP响应头类型。但是当我尝试在代码中设置它时:(这是在ActionFilter.OnActionExecuted方法中) 我最后有一个例外: InvalidOperationException:错误使用的标头名称。确保请求头与HttpRequestMessage一起使用,响应头与HttpResponseMessage一起使用,内容头与HttpContent对

  • 我有一个flask web应用程序,它使用render_template如下所示。我需要在响应中添加一个Content-Security-Policy作为额外的http响应头。我试着按照方法走,但都失败了,给了我500。 1. 在终端上,当我以localhost身份访问web应用程序时,会看到以下内容:3001 127.0.0.1--[06/APR/2015 01:45:01]“GET/HTTP/