Swagger-PHP注释,用于预定义的示例

时间:2019-04-01 20:54:41

标签: swagger openapi swagger-php

我正在使用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注释似乎没有重复之处。有什么建议吗?

0 个答案:

没有答案