Report Issue · Request Feature · Join Our Slack
OpenAPI is a specification for describing RESTful APIs. Functionally, it serves as a source of truth for API tooling, documentation, and testing. As such, it is essential for developers to understand the specification.
This reference is intended to be complementary of the official OpenAPI Specification Reference. It is focused on being dev-friendly: example-based with thorough explanations, plus AI search!
If you would like to contribute to this reference, please see the contributing guide.
At Speakeasy we are building the toolchain to make APIs easy to create and consume.
Today, our platform allows you to create a robust developer experience for your API using an OpenAPI spec:
- SDKs in 9 langues: TypeScript, Python, Go, Java, C#, Ruby, PHP, Swift and Unity
- Terraform Providers
Due to the nature of our work, we spend a lot of time working with OpenAPI and have become experts on how the spec impacts downstream workflows. This reference is a way for us to give back to the community and pass on some of the learning that we've done along the way.
While we have a lot of internal opinions on how to write OpenAPI, we value opinions from the community. We would love for contributions to this reference to come from a wide range of people, with different backgrounds and experiences.
This OpenAPI Reference is Open Source under the MIT, and is the copyright of its contributors. If you would like to contribute to the software, you must:
- Read the Developer Certificate of Origin Version 1.1 (https://developercertificate.org/)
- Signing all commits to the OpenAPI Reference project.
This ensures that users, distributors, and other contributors can rely on all the software related to Speakeasy being contributed under the terms of the License. No contributions will be accepted without following this process.
Afterwards, navigate to the contributing guide to get started.
This repository contains Speakeasy's OpenAPI Reference, covered under the MIT, except where noted (any Daytona logos or trademarks are not covered under the Apache License, and should be explicitly noted by a LICENSE file.)
Speakeasy is a product that makes use of this open source documentation. It is distributed under our commercial terms.
Others are allowed to make their own distribution of this documentation, but they cannot use any of the Speakeasy trademarks, cloud services, etc.
This project has adapted the Code of Conduct from the Contributor Covenant. For more information see the Code of Conduct.
For more information on how to use and develop Speakeasy, talk to us on Slack.
