Spec-URL

• OpenAPI 3 JSON: https://natomrade.airpipe.ai/openapi.json
• Swagger UI (interaktivt): https://natomrade.airpipe.ai/docs

Auto-genererad från FastAPI:s typannoteringar. Uppdateras vid varje deploy.

Generera SDK

Python (openapi-python-client)

pip install openapi-python-client
openapi-python-client generate --url https://natomrade.airpipe.ai/openapi.json

TypeScript (openapi-typescript)

npx openapi-typescript https://natomrade.airpipe.ai/openapi.json -o natomrade-types.ts

Go

go install github.com/deepmap/oapi-codegen/v2/cmd/oapi-codegen@latest
oapi-codegen -package natomrade https://natomrade.airpipe.ai/openapi.json > client.go

Postman-collection

I Swagger UI: klicka Authorize → skriv din API-nyckel → "Try it out" på vilken endpoint som helst. Du kan exportera collection till Postman.

Versioning

Vi använder URL-version (/api/v1/). Major version bumps kommer ge ny prefix (t.ex. /api/v2/) med samtidig support för v1 minst 6 mån.

Minor changes (nya optional fields, nya endpoints) gör vi i samma version utan breaking changes.

Bra praxis

• Pin SDK-version mot specifik OpenAPI hash i din build
• CI-genererad SDK istället för hand-edit
• Felhanteringskoder är dokumenterade i spec — använd dem