You do not need to run anything to try the API. Every endpoint page in the API Reference has a playground: choose the region, paste an API key, edit the body, and send. This page covers running Swagger UI yourself for cases the playground does not reach, such as a self-hosted deployment on a private network or a spec build from a branch.
Run Swagger UI locally
Swagger UI is a static site that renders any OpenAPI document. Run it in Docker against the published spec:
Open http://localhost:8081, click Authorize, and enter your API key for ApiKeyAuth. The Servers dropdown lists the US and India regions from the spec.
Requests from a local Swagger UI go straight to the Flexprice API with your key. Use a sandbox key while exploring.
Running Swagger UI against a self-hosted instance
A self-hosted Flexprice backend ships the same spec at docs/swagger/swagger-3-0.json in the repository. Serve Swagger UI next to it and point the server URL at your deployment:
Then in the UI, replace the server with http://localhost:8080/v1 (or your host) using the Servers dropdown’s editable field. If the browser blocks the request, the backend’s CORS setting needs to include the Swagger UI origin. See Configuration.
Swagger UI, Postman, or the API reference?
