SDK Sandboxes

Speakeasy can generate dev container configurations for SDK repositories to provide an intuitive, predefined sandbox environment to explore SDK capabilities. Beyond setting up this environment, Speakeasy has CLI commands that allow SDK users to effortlessly generate example usage snippets for any API operation within this container setting.

Configuring SDK Sandboxes

To set up the automatically generated dev container configurations, make minor adjustments to the gen.yaml file. The schemaPath shown below should reference the SDK’s OpenAPI document, which can be a local path or a remote URL.

Dev container gen.yaml:

Generation will create a .devcontainer directory containing a configuration file similar to below.

Generated devcontainer.json:

Using SDK Sandboxes in the browser

SDK users can instantly initialize a sandbox in GitHub Codespaces  with a single click. By default, GitHub Codespaces shifts the cost to the user. However, organizations can be configured  to offer complimentary codespaces to users if preferred.