Для нового REST-метода что ты будешь описывать и как?

Для нового REST-метода необходимо описать:

• Цель метода: что он делает, какую бизнес-задачу решает.
• HTTP-метод: GET, POST, PUT, DELETE и т.д.
• URL-адрес (эндпоинт): путь к ресурсу.
• Параметры запроса: query-параметры, path-параметры, заголовки.
• Тело запроса: формат и структура данных (например, JSON-схема).
• Ответ сервера: структура данных, коды статуса HTTP, возможные ошибки.
• Примеры запросов и ответов для наглядности.

Обычно это оформляется в виде API-документации, например, с помощью OpenAPI (Swagger), что позволяет стандартизировать описание и облегчить интеграцию.