Swagger пример ApiResponse - PullRequest
Новая
       46

Swagger пример ApiResponse

0 голосов
/ 08 марта 2020

Я пытаюсь задокументировать ответ API с примером тела json. Я не мог найти пример или подходящую аннотацию. Играя с редактором Swagger, я мог, по крайней мере, получить что-то похожее на результат, которого я хочу достичь. 

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(){}

Сгенерированный чван. json не имеет желаемого 

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

Я также попытался передать ответ = ApiResponse .class, examples.class и Example.class, но он не изменяется.

Как я могу сделать это с аннотациями?

...