Java / Swagger：生成请求示例

2024-05-02 • 问答

我正在尝试完成有关当前使用的Java API的详尽文档。

我想在控制器内部添加一个请求正文的示例，而不必将示例作为每个端点的JSON字符串编写。

是否可以直接从预期对象的模型中生成注释@ApiParam的示例的值？

我可以但不会做的例子：

@ApiParam(name = "newObject",value = "A new object",required = true,examples = @Example(value = @ExampleProperty(mediaType = MediaType.APPLICATION_JSON_VALUE,value = "{\"field\":\"value\",\"subobject\":{\"field\":\"value\"}}")))

祝你愉快

woshicgro 回答：Java / Swagger：生成请求示例

一种可能的解决方案可能是：

在初始化swagger之前的应用程序启动时，创建所有模型的对象，并使用示例数据填充它们。您可以使用某些库（Podam或其他任何库）来完成此操作。
将这些对象转换为JSON字符串并分配给类中的静态变量
在您的@ApiParam批注中使用此变量，类似于

@ApiParam(name = "newObject",value = "A new object",required = true,examples = @Example(value = @ExampleProperty(mediaType = MediaType.APPLICATION_JSON_VALUE,value = SomeClass.JSON_VALUE_VARIABLE)))

java spring swagger

本文链接：https://www.f2er.com/3152825.html

Java / Swagger：生成请求示例

woshicgro 回答：Java / Swagger：生成请求示例

大家都在问