Getting Started
Quickstart
Getting started with Speakeasy starts with your API document. This takes the form of an OpenAPI specification. Once you have your OpenAPI document available to you either locally or hosted at a stable URL you can log into the Speakeasy platform. Speakeasy will snapshot your API document, run linting rules, understand changes and give you the tools to launch robust, production ready SDKs.
For more information on how to get started with creating an OpenAPI document for your API see our reference guide on OpenAPI.
Now you're ready to get started and a beta version of your SDK in minutes.
-
Create an organisation and workspace on our platform (opens in a new tab). Invite more of your team mates to the workspace from the Team tab.
-
As prompted in the UI please install the Speakeasy CLI
brew install speakeasyapi/tap/speakeasy.
or
curl -fsSL https://raw.githubusercontent.com/speakeasy-api/speakeasy/main/install.sh | sh
- Run
speakeasy quickstartin any code directory or follow the instructions on the dashboard.
At this point you've finished basic setup. You should have the CLI installed and a basic SDK generated locally. 🎉🎉🎉
Now you can use various parts of the Speakeasy platform flexibly to best suite your needs. If you want to continue on exploring the platform and its features, the following steps will guide you through one way of creating and releasing a beta version of your SDK.
Polish and Iterate on your SDK for beta release
Improve your API Document
When running your OpenAPI document through quickstart, you may have seen WARN-ings be output after initial generation. These warnings are generated by the Speakeasy linter. The linter checks your API document
against a set of rules to ensure that it is well-formed and follows best practices.
You can also create and manage your own linting rulesets with a simple lint.yaml file to enforce your organisation's API standards. Check out the section on Linting
documentation for more information.