如何通过 Open API 3.0 @annotation描述我的对象的架构?

Question

可以为此使用注释吗？我不明白如何使用Yaml。

例：

@Operation(summary = "Get page of top by rating articles by title")
@ApiResponses(value = {
@ApiResponse(responseCode = "200 successful operation",
content = @Content(
mediaType = MediaType.APPLICATION_JSON_VALUE,
schema = @Schema(???)))
})
@GetMapping(value = {"/articles/topByRating"})
@JsonView({JsonViews.Short.class})
@ResponseStatus(HttpStatus.OK)
public ItemsDto<Article> getArticlesTopByRating(@RequestParam int numberPage, @RequestParam int sizePage) {
return articleCrud.getTopByRating(numberPage, sizePage);
}

项目Dto：

public class ItemsDto<E> {
Long total = 0L;
List<E> items;
}

品：

public class Article{
private Author author;
private String title;
private String body;
}

https://swagger.io/docs/specification/data-models/dictionaries/自由格式对象 "如果字典值可以是任何类型的(也称为自由格式对象(，请使用 extraalProperties： true：">

1.     type: object
2.     additionalProperties: true

我将尝试在注释中使用"ref = myfile.yaml"属性@Schema

Answer 1

该对象由 springdoc-openapi 自动转换为 Schema。

请注意，在 DTO 上，您还可以添加@Schema注释以自定义不同的字段。