Embed API Docs Anywhere
Open Source
Maintained by Stoplight
Free Forever
Whether you have an existing developer portal, or are working locally, you can use these components to add automatically generated API reference documentation that fits in seamlessly.
Powered by Standards
Leverage OpenAPI and JSON Schema to create beautiful, templated documents for even the most dynamic payloads, and encourage reuse with $ref.
Interactive API Console
Help developers get started faster by letting them test requests and responses within the documentation.
Code Samples
Do the heavy lifting for developers and kickstart integration by providing code samples in popular languages like Curl, Python, Ruby, Java, and many more.
Enhanced Markdown Support
Write rich tutorials and descriptions with Stoplight-flavored Markdown that gives the ability to add tabs, callouts, embed JSON examples, and much more.
Easy to Set Up
No build steps. Get started in minutes. Built on web components, it's as easy as adding a tag within your project, and can be used with any framework.
Delightful DX
Help developers find and consume APIs faster with a customizable left navigation and three-column layout.
Which Open Source API Documentation Tool Should You Choose?
Feature
Stoplight Elements
Elements DevPortal
Embed into existing CMS
Host Anywhere (S3, GitHub)
Try It (Interactive API Console)
OpenAPI 3.1 (OAS 3.1) Support
Multiple APIs
Mocking
Markdown Articles
Version Selector (Multiple Branches)
Search
Requires Stoplight Workspace
Already Using ReDoc or Swagger UI?
Stoplight Elements combines a great developer experience with best in class OpenAPI documentation. Moving from ReDoc or Swagger-UI to Stoplight Elements is painless.
- 1API File
- NoArticles/Markdown Support
- NoOpenAPI 3.1 support
- NoEmbedded Try It (aka Request Maker), JSON Schema, Callouts in Markdown
- 1API File
- NoArticles/Markdown Support
- NoOpenAPI 3.1 support
- NoEmbedded Try It (aka Request Maker), JSON Schema, Callouts in Markdown
- 0API File
- YesArticles/Markdown Support
- NoOpenAPI 3.1 support
- NoEmbedded Try It (aka Request Maker), JSON Schema, Callouts in Markdown
Starter Kits in Popular Frameworks
Not using one of these? Not a worry. You can use Elements in any HTML project.
No Vendor Lock-In
Use any OpenAPI editor you like, not just Stoplight Studio. There's no vendor lock-in, just a seamless optional integration. Point Elements at your OpenAPI and Markdown files or to your Stoplight Workspace.