Swagger-PHP аннотации для предопределенных примеров - PullRequest
Новая
       63

Swagger-PHP аннотации для предопределенных примеров

2 голосов
/ 01 апреля 2019

Я использую аннотации swagger-php для создания документации моего REST API, и я хотел бы использовать предопределенные примеры для описания ответов.

Код YAML ниже работает: 

components:
  examples:
    exampleUser:
      value:
        id: 1
        name:   "Alan Cool"
        email:  "joe@cool.com.br"
        password:   "string"
        status: "string"
        ultimo_acesso:  155850122
        cpf:    "string"
        rg: "string"
        cargo:  "string"
        grupo_id:   7
        empresa_id: 88
        thumbnail_id:   99
        loja_id:    1299

Но, пытаясь сгенерировать приведенный выше код с помощью аннотаций, я не могу заставить его работать. пытаюсь: 

/**
 * @OA\Examples(
 *    summary = "exampleUser",
 *    description = "exampleUser",
 *    value = "exampleUser"
 * )
 */

Кажется, что до сих пор нет аннотаций для PHP-аннотаций. Есть предложения?

...