swagger - 如何记录我没有所有权的对象?
问题描述
我正在返回一个Page<SomeObject>
在我的方法端点中。在我的 OpenAPI UI 中,如何生成来自org.springframework.data.domain.Page
类型的字段的描述。通常我所做的是转到我想要记录的对象并用@Schema(description = "some description")
. 但是我无法访问该Page
课程。我如何记录它的字段?
我可能在这里遗漏了一些简单的东西,但我们将不胜感激。
PS:我正在使用 OpenAPI v3 和 springdoc
解决方案
您可以使用 OpenApiCustomiser。
例如,假设您有这个控制器:
@RestController 公共类 HelloController {
@GetMapping("/hello")
Page<PersonDTO> getPage() {
return null;
}
}
假设您要在 Pageable 元素中添加描述:
@Bean
public OpenApiCustomiser pageableOpenApiCustomiser() {
return openApi -> {
Schema pageableSchema = openApi.getComponents().getSchemas().get("Pageable");
pageableSchema.setDescription("my description");
};
}
相同的逻辑适用于您需要自定义的任何其他属性。
推荐阅读
- android - E/RecyclerView:没有附加适配器;跳过布局 Kotlin Android
- python - 如何在 2 次之间获取 pandas 数据框列中的值?
- python - Pandas:根据 DataFrame 中的条件删除字符
- ios - 在 Swift 中使用协议扩展结构
- blazor - 在 Blazor 中渲染文件导致新选项卡
- jmeter - jmeter 登录测试 splunk 在 RHEL 8
- maven - 模块“xxx”是从 Maven 导入的。重新导入后对其配置所做的任何更改都可能丢失
- mongodb - 为什么 mongodb 的 findOneAndUpdate 在指定时会更新我的所有布尔字段?
- nuxt.js - Nuxt.js - 自动删除 URL 查询
- python - 如何在文本分类中使用 pos_tag