fetchsandbox
v0.4.0
Published
Turn any OpenAPI spec into a live developer portal with a stateful sandbox
Downloads
44
Maintainers
Readme
fetchsandbox
Turn any OpenAPI spec into a live developer portal with a stateful sandbox.
Install
npm install -g fetchsandboxOr run directly:
npx fetchsandbox generate ./openapi.yamlCommands
generate <spec>
Create a portal from an OpenAPI spec file or URL.
# From a local file
fetchsandbox generate ./stripe-openapi.yaml
# From a URL
fetchsandbox generate https://raw.githubusercontent.com/stripe/openapi/master/openapi/spec3.yamlOutput:
Spec loaded: Stripe API v2024-06-20 (327 endpoints)
Sandbox created: beed86d499
Seed data: 63 resources across 21 types
Your sandbox is ready:
API Key sandbox_3a4f93a4ea3ea857abb88deea90c3fcb
Base URL https://stripe.fetchsandbox.com
Portal https://fetchsandbox.com/docs/stripe
Try it:
curl https://stripe.fetchsandbox.com/v1/customers \
-H "api-key: sandbox_3a4f93a4ea3ea857abb88deea90c3fcb"status <sandbox-id>
Show sandbox state, resources, and recent activity.
fetchsandbox status stripereset <sandbox-id>
Reset sandbox to its original seed data.
fetchsandbox reset stripelist
List all sandboxes.
fetchsandbox listEnvironment
| Variable | Default | Description |
|----------|---------|-------------|
| FETCHSANDBOX_API_URL | https://fetchsandbox.com | API base URL |
Learn more
- fetchsandbox.com - Generate a portal from any OpenAPI spec
- Documentation - Example: Stripe API portal
- GitHub - Source and showcases
License
MIT
