如何解决如何在 OpenAPI 3 中正确定义可为空属性的示例?
我在 Spring Boot 中使用 OpenAPI 和 openapi-generator-maven-plugin。我正在尝试在我的响应中创建一个示例对象。我遵循了几个不同网页的建议,尤其是这个:
https://swagger.io/docs/specification/adding-examples/
但无论我怎么尝试,我都无法让示例数据正确显示。 这里应该是请求中的对象:
Period:
type: object
required:
- startDate
- endDate
properties:
startDate:
type: string
format: date
nullable: true
example: "2021-01-01"
endDate:
type: string
format: date
nullable: true
example: "2030-01-01"
CreateInstancesRequest:
type: object
required:
- id
properties:
id:
$ref: '#/components/schemas/Id'
period:
allOf:
- $ref: '#/components/schemas/Period'
但我没有得到我想要的:
我期待这样的事情:
{
"id": "some-id","period": {
"endDate": "2020-01-01","startDate": "2022-01-01"
}
}
但也许我错了,因为为 Period 类生成了 java 代码:
我认为实际示例中的 present
属性来自 org.openapitools.jackson.nullable.JsonNullable
类。
Jackson 的对象映射器配置如下:
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.registerModule(new JsonNullableModule());
objectMapper.registerModule(new JSR310Module());
objectMapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS,false);
你能帮我吗?
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。