REST API — обзор
OpenAPI 3.1, JSON, ETag, идемпотентность через Idempotency-Key.
База: https://api.h3llo.cloud. Описание: OpenAPI 3.1 spec (см. openapi/h3-api.yaml в репозитории).
Версионирование
URL: https://api.h3llo.cloud/v1/.... Backwards-compatible изменения — без бампа.
Breaking — новый major version. Старая версия живёт минимум 12 месяцев.
Формат
Content-Type: application/json— единственно поддерживаемый.- Все timestamp — RFC 3339, UTC, с миллисекундами.
- IDs — стабильные строки с префиксом ресурса:
i-...для instance,k-...для k8s.
Playground
Каждая endpoint-страница в этой документации — рабочий API-клиент. Через переключатель Server URL выбирается окружение:
- Production —
https://api.h3llo.cloud/v1 - Stage —
https://api.h3llo.pro/v1 - Локальный —
http://localhost:8080/v1(для разработки против локального h3-api)
Запросы из браузера к prod/stage идут с заголовком Origin: https://docs.h3llo.cloud;
этот origin есть в CORS-allowlist API. Локальный сервер должен сам разрешать
http://localhost:9300 (CLI: h3 api dev --cors-origin http://localhost:9300).