Я создал настраиваемую конечную точку с помощью платформы API. Вот аннотация, которую я использовал:
/**
* 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, теперь неточна. Он говорит:
/devices/pairing Creates a Pairing resource.
... что больше не соответствует действительности, поскольку мой контроллер не создает пары. (Вместо этого он обращается к другому API, прося этот API сделать что-то.)
Итак, вот мой вопрос: Как мне изменить мою аннотацию, чтобы я мог писать настраиваемую часть документации для этой конечной точки?
Вы можете использовать ключ swagger_context
для изменения любого поля Swagger, включая description
(то, которое вы ищете): https://api-platform.com/docs/core/swagger/#changing-operations-in-the-swagger-documentation
У меня это не сработало, вот как я сделал это с openapi_context:
"openapi_context" = {
"summary" = "test",
},