Java/Swagger : Generate request example

Question

我正在努力完成关于我目前使用的 Java API 的 swagger 文档。

我想在 Controller 中添加请求主体的示例，而不必为每个端点将示例编写为 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\"}}")))

祝你有个愉快的一天

Answer 1

一个可能的解决方案是:

• 在初始化 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)))