Как ты описывал REST-ручки — в Confluence или использовал другие инструменты?

Для описания REST API обычно использую специализированные инструменты, которые позволяют структурировать и документировать интерфейсы более эффективно, чем просто Confluence:

• OpenAPI (Swagger) — стандарт описания REST API с возможностью генерации документации и даже клиентского кода.
• Postman — для тестирования и документирования API, позволяет делиться коллекциями запросов.

Однако Confluence часто используется как дополнительное место для описания бизнес-логики, примеров использования, ограничений и общих принципов.

Пример описания REST-ручки в OpenAPI (YAML):

paths:
  /users/{id}:
    get:
      summary: Получить пользователя по ID
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      responses:
        '200':
          description: Успешный ответ
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        '404':
          description: Пользователь не найден