FazerCards Glossary
OpenAPI
A machine-readable description (YAML/JSON) of a REST API's endpoints, request bodies and responses. FazerCards publishes one at /public/docs.
OpenAPI (formerly Swagger) is the industry-standard format for describing REST APIs. A single openapi.json file enumerates every endpoint with its parameters, schemas, and example responses. Tools (Postman, code generators, IDEs) read it to scaffold clients in any language. FazerCards keeps its OpenAPI spec in sync with the live API so an integrator can generate a typed client in TypeScript, Python, or Go in minutes.
Key facts
- FazerCards' OpenAPI: https://api.fzr.cards/public/docs
- Used to auto-generate SDKs and Postman collections.
- Versioned — breaking changes ship as /api/v3, never as silent edits to /api/v2.