Swagger UI示例数据

Question

有没有一种方法可以显示示例数据;模型，输入和输入输出，查询参数，标题等？我在注释文档中找不到任何与此相关的内容; https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X

Answer 1

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

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

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