👀 Как читать API-документацию: пошаговая инструкция с примерами 👀

В задании по интеграциям на собеседовании вам скорее всего не дадут API-документацию. Это нормально, что в тестовых дают несколько названий методов внешних систем в формате POST /users и всё. Время ограничено.

А вот в реальной работе с интеграциями порой приходится анализировать достаточно большие документы. Аналитику важно уметь быстро читать их и разбираться с содержимым.

На примере интеграции по проекту #EventTasksGA, где нужно автоматически создавать задачи по организации нового мероприятия во внешней системе Todoist, разберёмся, как анализировать API-документацию.

API-документация для анализа:
🔗 https://developer.todoist.com/rest/v2/#getting-started

Действия аналитика:

Шаг 1. Найти и посмотреть оглавление
Шаг 2. Авторизация и аутентификация
Шаг 3. Тестовые доступы
Шаг 4. Рекомендации по использованию
Шаг 5. Общие требования к обработке ошибок
Шаг 6. Список методов для интеграции

Подробный разбор шагов с примеров в прикрепленной мини-книге 🤝

#ИнтеграцииGA