Stoplight Elements
Somerville, Massachusetts, United States
What it is
Stoplight Elements is a free, open-source set of web components for creating interactive API documentation from OpenAPI documents. It can be embedded in an existing site, where customizable left navigation and a three-column layout help organize API material. Readers can try requests and view responses in its embedded console. Elements supports OpenAPI, including version 3.1, and JSON Schema, and supplies code samples in Curl, Python, Ruby, and Java. Stoplight-flavored Markdown supports tabs, callouts, and embedded JSON examples. The components need no build steps and can be used with any framework or HTML project. Documentation can be hosted anywhere, including S3 or GitHub. Elements can reference an OpenAPI document or a Stoplight Workspace and can be used with any OpenAPI editor. The listed deployment options are web and self-hosted. Compared with Elements DevPortal, Elements does not list features such as multiple API listings, mocking, Markdown articles, branch version selection, or search. Stoplight identifies SmartBear as its parent company.
For and against
For
- Free and open source
- Supports OpenAPI 3.1 and JSON Schema
- Embedded console lets readers try API requests
- Works with any framework or HTML project
Against
- Does not list multiple API listings
The verdict
Stoplight Elements focuses on embedding interactive API documentation, with standards support and flexible hosting. Consider its listed omissions if your documentation needs include multiple API listings, mocking, version selection, or search.
Who it suits
Elements may suit developers who want to add interactive OpenAPI documentation to an existing site or HTML project. Its self-hosting and framework flexibility are useful for teams choosing their own hosting and web stack.
Plans and prices
Stoplight Elements
Open-source API documentation building blocks · Embed into existing CMS · Host anywhere · Interactive API console
Read 2 Oct 2026 · stoplight.io
On the record
- Code samples
- Elements provides code samples in languages including Curl, Python, Ruby, and Java.stoplight.io · read 2 Oct 2026
- Developer layout
- It offers customizable left navigation and a three-column layout for browsing API documentation.stoplight.io · read 2 Oct 2026
- Examples
- The product page says Spotify uses Elements for its “Get Artist” documentation on Spotify for Developers.stoplight.io · read 2 Oct 2026
- Hosting
- The product page says Elements can be hosted anywhere, including S3 or GitHub.stoplight.io · read 2 Oct 2026
- Integration
- Elements can use any OpenAPI editor and optionally point to an OpenAPI document or a Stoplight Workspace.stoplight.io · read 2 Oct 2026
- Interactive console
- The embedded API console lets readers test requests and responses within the documentation.stoplight.io · read 2 Oct 2026
- Maker
- The Stoplight site identifies SmartBear as its parent company.stoplight.io · read 2 Oct 2026
- Markdown
- Stoplight-flavored Markdown supports tabs, callouts, and embedded JSON examples.stoplight.io · read 2 Oct 2026
- Notable limits
- Compared with Elements DevPortal, Elements does not list multiple APIs, mocking, Markdown articles, branch version selection, or search.stoplight.io · read 2 Oct 2026
- Security
- Stoplight says it uses industry-standard technologies and services to protect data and conducts employee background checks and recurring security training.stoplight.io · read 2 Oct 2026
- Setup and frameworks
- Elements requires no build steps, is built on web components, and can be used with any framework or HTML project.stoplight.io · read 2 Oct 2026
- Standards
- Elements uses OpenAPI and JSON Schema, including OpenAPI 3.1 support.stoplight.io · read 2 Oct 2026
- What it does
- Stoplight Elements builds customized, interactive API documentation from OpenAPI documents using embeddable web components.stoplight.io · read 2 Oct 2026
