OpenAPI Specification

The Basker Partner API provides an OpenAPI specification that describes all available endpoints, request/response schemas, and authentication requirements.

Accessing the Specification

The OpenAPI specification is available at the following endpoint:

GET https://api.basker.app/partners/2025-07/openapi

Available Formats

You can request the specification in different formats using the format query parameter:

OpenAPI 3.1 (default)

curl https://api.basker.app/partners/2025-07/openapi

OpenAPI 3.0

curl https://api.basker.app/partners/2025-07/openapi?format=openapi3.0

Swagger 2.0

curl https://api.basker.app/partners/2025-07/openapi?format=swagger2.0

Using the Specification

API Documentation Tools

The specification can be imported into various API documentation and testing tools:

• Postman: Import directly via URL or download and import the JSON file
• Insomnia: Use the import feature with the specification URL
• Swagger UI: Point Swagger UI to the specification endpoint
• OpenAPI Generator: Generate client SDKs in various languages

Example: Generate a TypeScript Client

# Install OpenAPI Generator
npm install -g @openapitools/openapi-generator-cli

# Generate TypeScript client
openapi-generator-cli generate \
  -i https://api.basker.app/partners/2025-07/openapi \
  -g typescript-axios \
  -o ./basker-api-client

Example: Import to Postman

1. Open Postman
2. Click “Import” → “Link”
3. Enter: https://api.basker.app/partners/2025-07/openapi
4. Click “Continue” → “Import”

Specification Updates

The OpenAPI specification is automatically generated from the API implementation, ensuring it stays up-to-date with the latest changes. When new endpoints or fields are added, they will be reflected in the specification immediately.

CORS Support

The OpenAPI endpoint includes CORS headers, allowing it to be accessed directly from browser-based tools and documentation viewers.