Платформа API: изменение описания конечной точки - PullRequest
Новая
       58

Платформа API: изменение описания конечной точки

0 голосов
/ 04 сентября 2018

Я создал пользовательскую конечную точку с помощью API Platform. Вот аннотация, которую я использовал: 

/**
 * We only want the POST option for now.
 *
 * @ApiResource(
 *      itemOperations={},
 *      collectionOperations={"post"={
 *           "method"="POST",
 *           "controller"=PairingController::class,
 *           "path"="/devices/pairing",
 *           "defaults"={"_api_receive"=false}
 *     }},
 * )
 *
 *
 */
class Pairing
{
...

Контроллер, который я вызываю, выполняет некоторую пользовательскую логику. Я доволен тем, как все работает до сих пор. Но документация, созданная API Platform, теперь неточна. Там написано:

/ devices / pairing Создает ресурс сопряжения.

... что больше не соответствует действительности, поскольку мой контроллер не генерирует сопряжение. (Вместо этого он обращается к другому API, запрашивая у этого API какие-то вещи.)

Итак, вот мой вопрос: Как мне изменить мою аннотацию, чтобы позволить мне написать собственный фрагмент документации для этой конечной точки?

1 Ответ

0 голосов
/ 12 сентября 2018

Вы можете использовать клавишу swagger_context, чтобы изменить любое поле Swagger, включая description (то, которое вы ищете): https://api -platform.com / docs / core / swagger / # change- операции-в-развязность-документации

...