Глоссарий FazerCards
OpenAPI
Машиночитаемое описание REST-API (YAML/JSON) — список эндпойнтов, тел запросов и ответов. У FazerCards публикуется на /public/docs.
OpenAPI (раньше Swagger) — индустриальный стандарт описания REST API. Один openapi.json перечисляет все эндпойнты со схемами и примерами. Инструменты (Postman, генераторы кода, IDE) читают его и собирают клиенты в любом языке. FazerCards держит OpenAPI в синхроне с боевым API, так что интегратор за минуты генерирует типизированный клиент на TypeScript, Python или Go.
Главные факты
- OpenAPI: https://api.fzr.cards/public/docs
- Используется для авто-генерации SDK и Postman-коллекций.
- Версионируется: breaking-изменения выходят как /api/v3, не как тихие правки /api/v2.