时间戳

首页 > 解决方案 > 招摇 ApiResponse 示例

swagger - 招摇 ApiResponse 示例

问题描述

我正在尝试使用 json 正文的示例记录 api 错误响应。我找不到示例或合适的注释。玩弄摇摇晃晃的编辑器，我至少可以得到一些看起来像我想要达到的结果。

responses:
    '200' :
      description: Request completed with no errors
      examples:   
        application/json:  {"result" : { "id": "blue" }}

图书馆是 swagger-core 1.6.0

 <dependency>
            <groupId>io.swagger</groupId>
            <artifactId>swagger-core</artifactId>
            <scope>compile</scope>
            <version>1.6.0</version>
</dependency>

并且端点是使用 jax-rs 创建的。

我对端点做了这个

@ApiResponses(value = {
    @ApiResponse(code = 200, message = "OK",
            examples = @Example(value = @ExampleProperty(mediaType = "application/json", value = "{\"result\" : { \"id\": \"blue\" }}"))
    )
})
public Response getResult(){}

生成的 swagger.json 没有所需的

examples:   
 application/json:  {"result" : { "id": "blue" }}

我也尝试传递 response = ApiResponse.class、Examples.class 和 Example.class 但它没有改变。

如何使用注释来做到这一点？

标签： swaggerjax-rsswagger-2.0swagger-codegenswagger-editor

解决方案

推荐阅读