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

Я создал настраиваемую конечную точку с помощью платформы 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 сделать что-то.)

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

Стоит ли изучать PHP в 2023-2024 годах?
Стоит ли изучать PHP в 2023-2024 годах?
Привет всем, сегодня я хочу высказать свои соображения по поводу вопроса, который я уже много раз получал в своем сообществе: "Стоит ли изучать PHP в...
Symfony Station Communiqué - 7 июля 2023 г
Symfony Station Communiqué - 7 июля 2023 г
Это коммюнике первоначально появилось на Symfony Station .
Оживление вашего приложения Laravel: Понимание режима обслуживания
Оживление вашего приложения Laravel: Понимание режима обслуживания
Здравствуйте, разработчики! В сегодняшней статье мы рассмотрим важный аспект управления приложениями, который часто упускается из виду в суете...
Установка и настройка Nginx и PHP на Ubuntu-сервере
Установка и настройка Nginx и PHP на Ubuntu-сервере
В этот раз я сделаю руководство по установке и настройке nginx и php на Ubuntu OS.
Коллекции в Laravel более простым способом
Коллекции в Laravel более простым способом
Привет, читатели, сегодня мы узнаем о коллекциях. В Laravel коллекции - это способ манипулировать массивами и играть с массивами данных. Благодаря...
Как установить PHP на Mac
Как установить PHP на Mac
PHP - это популярный язык программирования, который используется для разработки веб-приложений. Если вы используете Mac и хотите разрабатывать...
2
0
1 821
2
Перейти к ответу Данный вопрос помечен как решенный

Ответы 2

Ответ принят как подходящий

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

У меня это не сработало, вот как я сделал это с openapi_context:

"openapi_context" = {
    "summary" = "test",
},

Другие вопросы по теме