symfony — Где поместить @SWG \ Definition для повторного использования с Swagger-PHP и Nelmio API-DOC Bundle
Я хотел бы где-нибудь написать @SWG \ Definition и обратиться к нему в аннотациях @SWG \ Schema в @SWG \ Response для нескольких действий REST API в моем приложении Symfony 3. Я использую версию api-doc-bundle от Nelmio, разработанную dev-master, но, похоже, я могу найти что-нибудь, что подсказывает, куда должно идти это определение. Документы Swagger-PHP призывают не повторяться, если это возможно, и я хотел бы следовать этой рекомендации. Есть намеки?
Решение
Типичный … В конце концов сломайтесь и спросите, а затем выясните решение вскоре после …
Я обнаружил, что могу предварительно загрузить данные документации в app / config / config.yml Symfony.
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")
* )
* )
*/
Другие решения
Других решений пока нет …
detector