php - Swagger-PHP および Nelmio API-DOC バンドルで再利用する @SWG\Definition を配置する場所

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")
 *     )
 * )
 */