何处将@SWG \ Definition与Swagger-PHP和Nelmio API-DOC Bundle一起使用

Question

我想在某处编写一个@SWG \ Definition，并在我的Symfony 3应用程序中的多个REST API操作的@SWG \ Response注释中的@SWG \ Schema中引用它。我正在使用Nelmio的api-doc-bundle的dev-master版本，但我似乎可以找到任何暗示该定义应该去的地方。 Swagger-PHP文档敦促如果可能不重复，我想遵循该建议。任何提示？

Answer 1

典型......最后分解并询问，然后在......之后不久找出解决方案。

我发现我可以在Symfony的app / config / config.yml中预加载文档数据。

nelmio_api_doc:
    documentation:
        definitios:
            Error: 
                type: object
                properties:
                    success:
                        type: boolean
                        example: false
                    error:
                        type: string
                        example: message

现在我可以在所有REST操作中使用这样的东西

/**
 *  @API\Operation(
 *     ...
 *     @SWG\Response(
 *         response="default",
 *         description="Failure",
 *         @SWG\Schema(ref="#definitions/Error")
 *     )
 * )
 */