Elements

Open-source API documentation building blocks.

Build highly customized, interactive API Docs with embeddable web components generated from OpenAPI documents.

Embed API docs anywere.

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. Open-source and maintained by Stoplight.

Dyte provides developer friendly live video SDKs that allows you to easily add 1:1 calls, group calls right within your platform.

Check out Dyte's docs

Spotify utilizes Elements for their “Get Artist” documentation on their Spotify for Developers site.

Check out Spotify's docs

Authmoji uses Stoplight for their ‘create an account’ documentation.

Check out Authmoji's docs

Explore the benefits of Elements.

Delightful developer experience.

Help developers find and consume APIs faster with a customizable left navigation and three-column layout.

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.

Accelerate developer onboarding by letting them test requests and responses within the documentation.

Code samples.

Streamline Integration by providing code samples in popular languages like Curl, Python, Ruby, Java, and many more.

Enhanced markdown support.

Provide engaging guides 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.

Which open-source API documentation tool is right for you?

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.

1
1 API file
No articles/markdown support
No OpenAPI 3.1 support
No embedded Request Maker (aka "try it"), JSON schema, or callouts in markdown
1
1 API file
No articles/markdown support
No OpenAPI 3.1 support
No embedded Request Maker (aka "try it"), JSON schema, or callouts in markdown
0
0 API files
Yes articles/markdown support
No OpenAPI 3.1 support
No embedded Request Maker (aka "try it"), JSON schema, or callouts in markdown

Starter kits in popular frameworks.

Not using one of these? Not a worry. You can use Elements in any HTML project.

Gatsby logoAngular logoReact logo

No vendor lock-in.

Use any OpenAPI editor you like, not just Stoplight Platform. There's no vendor lock-in, just a seamless optional integration. Point Elements at your OpenAPI or to your Stoplight Workspace.

Ready to build your own interactive API docs?