Мне нужно добавить несколько примеров для @Parameter в springdo c -openapi, но эти примеры не генерируются. - PullRequest
Новая
       84

Мне нужно добавить несколько примеров для @Parameter в springdo c -openapi, но эти примеры не генерируются.

0 голосов
/ 08 апреля 2020

Я пытаюсь добавить документацию по чванству в свой проект. Мне нужно добавить несколько примеров для @Parameter в @RequestBody для Sample.class. Следующий фрагмент кода - это то, как это упоминается, чтобы быть написанным в документации. 

@PostMapping("/")
    public Sample createSample(@Parameter(description="Sample description", examples = {
            @ExampleObject(name="foo", description = "na",summary = "na",value = "{\n" +
                    "  \"id\": 10,\n" +
                    "  \"name\": \"ashith\",\n" +
                    "  \"description\": \"none\"\n" +
                    "}"),
            @ExampleObject(name="bar",description = "na",summary = "na",value = "{\n" +
                    "  \"id\": 20,\n" +
                    "  \"name\": \"Akshatha\",\n" +
                    "  \"description\": \"ok\"\n" +
                    "}")
    }
    )
                                   @RequestBody Sample sample) {

Сгенерированный вывод yaml выглядит следующим образом: 

openapi: 3.0.1
info:
  title: OpenAPI definition
  version: v0
servers:
  - url: 'http://localhost:8080/'
    description: Generated server url
paths:
  /api/another/:
    post:
      tags:
        - another-controller
      operationId: createSample
      requestBody:
        description: Sample description
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Sample'
        required: true
      responses:
        '200':
          description: default response
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/Sample'
        '400':
          description: default response
          content:
            '*/*':
              schema:
                type: string
        '404':
          description: default response
          content:
            '*/*':
              schema:
                type: string

Кажется, что отсутствуют примеры, которые должны были быть добавлены в соответствии с кодом

...