OpenAPI Specification¶
API documentation and downloadable specifications.
Interactive Documentation¶
View the API documentation using ReDoc:
-
ReDoc Viewer
Clean, readable API documentation
Versioned Documentation
The ReDoc link above uses the latest version. For a specific version, use:
https://redocly.github.io/redoc/?url=https://tomblancdev.github.io/stromboli/VERSION/swagger/swagger.yaml
Replace VERSION with 0.2.0, latest, etc.
Download Specifications¶
Download the raw OpenAPI specification files:
| Format | Latest | v0.2.0 |
|---|---|---|
| YAML | swagger.yaml | swagger.yaml |
| JSON | swagger.json | swagger.json |
Usage Examples¶
Import into Postman¶
# Download the spec
curl -O https://tomblancdev.github.io/stromboli/latest/swagger/swagger.yaml
# Then in Postman: File > Import > Upload Files
Generate Client SDK¶
# Using openapi-generator (Python client)
openapi-generator generate \
-i https://tomblancdev.github.io/stromboli/latest/swagger/swagger.yaml \
-g python \
-o ./stromboli-client
# Using openapi-generator (TypeScript client)
openapi-generator generate \
-i https://tomblancdev.github.io/stromboli/latest/swagger/swagger.yaml \
-g typescript-fetch \
-o ./stromboli-ts-client
Validate the Spec¶
# Using spectral
npx @stoplight/spectral-cli lint \
https://tomblancdev.github.io/stromboli/latest/swagger/swagger.yaml
Versioned URLs¶
Each Stromboli release has its own OpenAPI spec:
| Version | ReDoc | YAML | JSON |
|---|---|---|---|
| latest | View | Download | Download |
| 0.2.0 | View | Download | Download |
Local Server¶
When running Stromboli locally, the spec is also available at: