We want your feedback! Contribute your thoughts on Stoplight features on our roadmap below.
OpenAPI 3.1 is the latest OpenAPI version and was released in early 2021.
Now, Stoplight has taken the first step to support OpenAPI 3.1 documents with our current features, tools, and functionality. We’ve enabled all of our Stoplight Platform tools to accept OpenAPI 3.1 documents including Studio, Prism, Spectral, and documentation.
What’s in this release?
- OAS 3.1 in Studio
- Prism now accepts OAS 3.1 documents
- Generate docs for OAS 3.1
- Spectral validation for OAS 3.1 documents
We know that OpenAPI 3.1 introduced a few major features such as webhooks and support for the latest JSON Schema draft. However, our goal with this release was to enable users to leverage OpenAPI 3.1 with existing Stoplight tools and features.
Of course, using the OpenAPI Specification offers many benefits for API design and development, from documentation, to security, to microservices development. Here are a few of the other benefits of OpenAPI:
- Develper-Friendly Documentation – OpenAPI is known for its easily readable documentation for humans and computers, leaving you with happy developers.
- Language-Agnostic – Users can interact with API servers without knowing the implementation of the server. Other formats like API Blueprint require third-party code on the server.
- Good Governance – The OpenAPI initiative maintains the OpenAPI standard and is moderated by industry leaders to obtain quality of standards across the board.
- Likelier Adoption – OpenAPI is the most popular format for describing REST APIs. The extent of its adoption indicates that OpenAPI is here for the long run.
- Robust tools – Being the most widely supported format, there is now a proliferation of tools (including us!!) that leverage OpenAPI for generating documentation, testing, and more.
If you’re looking to take advantage of all of the brand-new capabilities of OpenAPI 3.1, our tools now support your workflow and enable the use of OAS 3.1 with other tooling or providers.
Curious about the differences between Open API 2.0, 3.0, and 3.1? Learn more in this blog.
We Want Your Feedback
Now that OpenAPI 3.1 documents are supported in Stoplight, what do you want to see next? What OpenAPI 3.1 features would be the most useful? Add it, or upvote it on our roadmap here.
