SDK Creation Overview
|Language||Generation (GH, App, CLI)||Package Manager|
To get started with Speakeasy SDK creation, you will need an API spec in one of our supported formats:
These instructions are for creating SDKs using the managed pipeline in the web app. If you prefer to set up the CI/CD using a GitHub action, you can find instructions here.
Navigate to the SDK tab in your workspace to start configuring your SDK pipeline.
Before uploading your spec, you'll need to specify a
version for your API:
API Nameshould be a string that identifies the purpose of your API.
API Versionshould be a string that represents the version of your API. You should typically match the version to the version specified in the info section of your API spec.
You also need to upload the spec, which you can do from a publicly hosted spec or from a local file:
- If your API spec is hosted publicly, provide the URL in the
- If your spec file is on your local machine, drag and drop the file onto the upload area or click on the upload area to select the file and upload.
Note that if the spec is hosted on GitHub, you'll need to provide the raw URL.
Speakeasy will validate your uploaded spec to make sure it has everything required to produce a complete SDK.
If the validation fails, you will be presented with a list of errors and warnings.
Before proceeding to SDK creation, you will need to resolve all errors and warnings. If you are unsure of how to resolve a particular error or warning, please join our Slack community (opens in a new tab) and ask for help in the #general channel.
The last thing to do is select the languages you will generate SDKs for. For each language that you need, click the Not Configured dropdown and configure the destination repository name.
Different languages have different settings that are relevant when you publish your SDKs. You can leave these settings with placeholders for now and return to them when you're ready to publish.
Once you've selected the languages you want to generate for, click the Start Generating button to kick off the SDK generation process.
Generating SDKs is the first step, but there are several optimizations you can make to improve the quality of your SDKs. We recommend you check out the following guide on customizing your SDKs.