swagger - Swagger UI 示例数据

Question

有没有办法大摇大摆地显示示例数据；模型，输入和输出，查询参数，标题等？我无法在注释文档中找到与此相关的任何内容； https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X

Answer 1

如果您查看 wiki 中提到的一些注释的文档，您会看到它们的可选参数中有一个称为exampleor examples。您可以使用此参数添加一个或多个示例（如果允许）。

例如，对于查询参数，您可以使用@ApiParam注释执行此操作：

@Path("/{username}")
@ApiOperation(value = "Updated user")
public Response updateUser(
  @ApiParam(example = "moondaisy") @QueryParam("username") String username
) {
...
}