duanlang0025 2017-10-27 16:18
浏览 285

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

I'd like to write a @SWG\Definition somewhere and refer to it in the @SWG\Schema in @SWG\Response annotations for multiple REST API actions in my Symfony 3 application. I'm using the dev-master version of Nelmio's api-doc-bundle but I can seem to find anything that suggests where that definition should go. The Swagger-PHP docs urge not repeating if possible and I'd like to follow that recommendation. Any hints?

  • 写回答

1条回答 默认 最新

  • doujiang2812 2017-10-27 17:06
    关注

    Typical... Finally break down and ask then figure out a solution shortly after...

    I found that I can preload the documentation data in Symfony's app/config/config.yml.

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

    Now I can use something like this in all my REST actions

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

报告相同问题?

悬赏问题

  • ¥15 基于卷积神经网络的声纹识别
  • ¥15 Python中的request,如何使用ssr节点,通过代理requests网页。本人在泰国,需要用大陆ip才能玩网页游戏,合法合规。
  • ¥100 为什么这个恒流源电路不能恒流?
  • ¥15 有偿求跨组件数据流路径图
  • ¥15 写一个方法checkPerson,入参实体类Person,出参布尔值
  • ¥15 我想咨询一下路面纹理三维点云数据处理的一些问题,上传的坐标文件里是怎么对无序点进行编号的,以及xy坐标在处理的时候是进行整体模型分片处理的吗
  • ¥15 CSAPPattacklab
  • ¥15 一直显示正在等待HID—ISP
  • ¥15 Python turtle 画图
  • ¥15 stm32开发clion时遇到的编译问题