~/VibeHandbook

Глава 04 · 08

Как читать документацию API

Вы будете жить в документации API, так что вот как быстро получить то, что вам нужно, не читая её целиком. Для любого эндпоинта охотьтесь за пятью вещами:

  • Метод и URLGET /forecast. Что он делает, в двух токенах.
  • Аутентификация — какой заголовок или ключ ему нужен. Обычно один общий раздел на весь API.
  • Параметры — входные данные, которые вы можете отправить (здесь city), какие из них обязательны, и их типы.
  • Пример ответа — форма JSON, которую вы получите обратно. Это золото; скопируйте его.
  • Ошибки — что приходит, когда что-то не так, и коды статуса (401 не авторизован, 404 не найдено, 429 лимит запросов).

Хорошая документация включает пример запроса и ответа, готовый к копированию. Эти два фрагмента скажут вам больше, чем абзацы текста — хватайте их и отдавайте ИИ.

Хотите офлайн-версию?

Получите PDF + EPUB + скачиваемую библиотеку промптов + обновления версий.

$ Получить PDF — $39