API
OpenAPI
Full API schema and interactive docs.
Swush publishes an OpenAPI JSON at:
/api/v1/openapiYou can use it with Postman, Insomnia, or any OpenAPI tooling.
Fetch example
curl -s https://your-domain.com/api/v1/openapi > openapi.jsonImport in Postman
- Open Postman → Import
- Paste the URL:
https://your-domain.com/api/v1/openapi - Create a collection
OpenAPI config (example)
If you need a static config in your tooling, use:
{
"openapi": "3.0.3",
"info": {
"title": "Swush API",
"version": "1.0.0"
},
"servers": [{ "url": "https://your-domain.com" }],
"components": {
"securitySchemes": {
"ApiKeyAuth": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
}
}
},
"security": [{ "ApiKeyAuth": [] }]
}