невозможно добавить сводку при использовании Swagger 3 для документации платформы API - PullRequest
1 голос
/ 05 марта 2020

Я хочу добавить документацию для моей платформы API, используя swagger 3. Мой конфигурационный файл API:

api_platform:
    # The title of the API.
    title: 'API title'
    # The description of the API.
    description: 'API description'
    # The version of the API.
    version: '0.0.0'
    mapping:
        paths: ['%kernel.project_dir%/src/Entity']
    patch_formats:
        json: ['application/merge-patch+json']
    swagger:
        versions: [3]
    collection:
        pagination:
            enabled: false
            items_per_page : 20
            client_enabled: true
            client_items_per_page: true
            items_per_page_parameter_name: "count"
    eager_loading:
        enabled: false

В моей сущности я добавил itemOperations и попытался добавить сводку:

 itemOperations={
 *          "get"={"method"="GET"},
 *          "put"={"method"="PUT"},
 *          "delete"={"method"="DELETE"},
 *          "increment"={
 *         "method"="post",
 *         "path"="/invoices/{id}/increment",
 *         "controller"="App\Controller\InvoiceIncrementationController",
 *         "swagger_context"={
 *             "summary"="my text"  // <<<<<-------- want to add a text
 *         }
 *       }
 *     },

Я не смог добавить текст, но когда я понизил версию чванства к 2 я получил свой текст.

Как добавить резюме для чванства 3?

1 Ответ

2 голосов
/ 05 марта 2020

Для Swagger v3 вместо swagger_context используйте openapi_context

...