swagger - 我如何记录我没有所有权的对象？

Question

我要返回 Page<SomeObject>在我的方法端点。在我的 OpenAPI UI 中，如何生成对来自 org.springframework.data.domain.Page 的字段的描述类型。 通常我所做的是转到我想要记录的对象并用 @Schema(description = "some description") 注释它的字段。 .但我无权访问 Page类(class)。我如何记录它的字段？

我可能在这里遗漏了一些简单的东西，但我们将不胜感激。

PS:我使用的是 OpenAPI v3 和 springdoc

Answer 1

您可以使用 OpenApiCustomiser。

例如，假设您有这个 Controller :

@RestController 公共(public)类 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");
    };
}

相同的逻辑适用于您需要自定义的任何其他属性。