2

我正在记录我的 api 之一，其中包含多个这样的示例：

@Operation(summary = "Create new")
@PostMapping("")
public ResponseEntity<Object> createOne(
        @Parameter(description = "MyDto")
        @io.swagger.v3.oas.annotations.parameters.RequestBody(
                content = @Content(examples = {
                        @ExampleObject(name = "one", value = EXAMPLE_ONE),
                        @ExampleObject(name = "two", value = EXAMPLE_TWO),
                        @ExampleObject(name = "three", value = EXAMPLE_THREE)}
                ))
        @RequestBody MyDTO body
) {
    ...
}

这很好用，尽管EXAMPLE_ONE 是一个字符串值。从下面的示例中可以看出，这很不清楚

    private static final String EXAMPLE_ONE = "{\"glossary\":{\"title\":\"example glossary\",\"GlossDiv\":{\"title\":\"S\",\"GlossList\":{\"GlossEntry\":{\"ID\":\"SGML\",\"SortAs\":\"SGML\",\"GlossTerm\":\"Standard Generalized Markup Language\",\"Acronym\":\"SGML\",\"Abbrev\":\"ISO 8879:1986\",\"GlossDef\":{\"para\":\"A meta-markup language, used to create markup languages such as DocBook.\",\"GlossSeeAlso\":[\"GML\",\"XML\"]},\"GlossSee\":\"markup\"}}}}}";

我正在寻找一种更好的方法来提供示例。一个json文件会很好，但我找不到任何关于它的东西。

4

1 回答 1

0

您可以使用 externalValue 代替 value。看这里

于 2021-08-16T17:10:01.313 回答