繁体   English   中英

将@SWG \\ Definition放在哪里,以便与Swagger-PHP和Nelmio API-DOC捆绑包一起重用

[英]Where to put @SWG\Definition to be reused with Swagger-PHP and Nelmio API-DOC Bundle

我想在某处编写一个@SWG \\ Definition,并在我的Symfony 3应用程序中的多个REST API动作的@SWG \\ Response批注的@SWG \\ Schema中引用它。 我正在使用Nelmio的api-doc-bundle的dev-master版本,但似乎可以找到暗示该定义应该去哪里的任何内容。 Swagger-PHP文档敦促尽可能避免重复,我希望遵循该建议。 有什么提示吗?

典型...最后分解,然后在不久后提出解决方案...

我发现可以将文档数据预加载到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")
 *     )
 * )
 */

暂无
暂无

声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

 
粤ICP备18138465号  © 2020-2024 STACKOOM.COM