首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >要在Swagger-PHP和Nelmio API-DOC捆绑包中重用的@SWG\Definition放在哪里

要在Swagger-PHP和Nelmio API-DOC捆绑包中重用的@SWG\Definition放在哪里
EN

Stack Overflow用户
提问于 2017-10-28 00:18:14
回答 1查看 1.5K关注 0票数 0

我想在某个地方编写一个@SWG\定义,并在@SWG\Response注释中的@SWG\Schema中引用它,用于我的Symfony 3应用程序中的多个REST API操作。我使用的是Nelmio的api-doc-bundle的dev-master版本,但我似乎可以找到任何建议这个定义应该放在哪里的东西。Swagger-PHP文档敦促如果可能的话,不要重复,我想遵循这个建议。有什么提示吗?

EN

回答 1

Stack Overflow用户

发布于 2017-10-28 01:06:22

典型的。最后分解并询问,然后很快找出解决方案……

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

代码语言:javascript
复制
nelmio_api_doc:
    documentation:
        definitios:
            Error: 
                type: object
                properties:
                    success:
                        type: boolean
                        example: false
                    error:
                        type: string
                        example: message

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

代码语言:javascript
复制
/**
 *  @API\Operation(
 *     ...
 *     @SWG\Response(
 *         response="default",
 *         description="Failure",
 *         @SWG\Schema(ref="#definitions/Error")
 *     )
 * )
 */
票数 1
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/46979473

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档