Open Source API Documentation Building Blocks

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

https://d33wubrfki0l68.cloudfront.net/ec084c94a7e626e21ee434180e474c8a145d8d7b/691f1/images/elements/elements-landing-hero.png
      

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.

https://d33wubrfki0l68.cloudfront.net/7b86abfbf7705b272db4006ee81f7f125f53db66/98309/images/elements/openapi.svg

Powered by Standards

Leverage OpenAPI and JSON Schema to create beautiful, templated documents for even the most dynamic payloads, and encourage reuse with $ref.

https://d33wubrfki0l68.cloudfront.net/cef28c506c987f88620d0a2dedcfcef429abda6f/21fab/images/elements/terminal.svg

Interactive API Console

Help developers get started faster by letting them test requests and responses within the documentation.

https://d33wubrfki0l68.cloudfront.net/470d21c9659211e28bf77f11d9333101a7f9ab1a/11daf/images/elements/code.svg

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.

https://d33wubrfki0l68.cloudfront.net/dd88f65e3950aed4fef06895903327c6c5563059/df037/images/elements/markdown-mark.svg

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.

https://d33wubrfki0l68.cloudfront.net/99ed12ea051f1e79716fd4e7478a6872b47169c2/8f241/images/elements/stopwatch.svg

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.

https://d33wubrfki0l68.cloudfront.net/f307eb1b705af8f22b514969acd5662fc55df397/eeb4d/images/elements/smile-beam.svg

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)
Multiple APIs
Mocking
Markdown Articles
Version Selector (Multiple Branches)
OpenAPI 3.1 (OAS 3.1) Support
Search
Command Line
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.

    
https://d33wubrfki0l68.cloudfront.net/1f06505b5fea980491e42e65725687c9b0f8efae/34af0/images/logos/swaggerhub-logo.png
  • 1API File
  • NoArticles/Markdown Support
  • NoOpenAPI 3.1 support
  • NoEmbedded Try It (aka Request Maker), JSON Schema, Callouts in Markdown
https://d33wubrfki0l68.cloudfront.net/e0992b2c8a520892539040cd52b8e12e3dca0c4d/05634/images/logos/redoc-logo.png
  • 1API File
  • NoArticles/Markdown Support
  • NoOpenAPI 3.1 support
  • NoEmbedded Try It (aka Request Maker), JSON Schema, Callouts in Markdown
https://d33wubrfki0l68.cloudfront.net/95a9a5b3a5572b5d9c6330151c560bbadb8c6a33/42540/images/logos/logo-slate.png
  • 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

https://d33wubrfki0l68.cloudfront.net/463dd9ebbbfa5423dbfd0201820d168be1363616/293a5/images/elements/gatsby.svg
https://d33wubrfki0l68.cloudfront.net/1e44d437e6713e8534ee60a0abfc985b4023b0b8/b70ac/images/elements/angular.svg
https://d33wubrfki0l68.cloudfront.net/cd83ef1da330190708743a332d256702dfa1dabc/7e3ad/images/elements/react.svg
Not using one of these? Not a worry. You can use Elements in any HTML project.
    
      

No Vendor Lock-In

https://d33wubrfki0l68.cloudfront.net/ca2334606f7a38783275d1f2735359f91f19f48a/62026/images/home/logo-blue-black.png
https://d33wubrfki0l68.cloudfront.net/7b86abfbf7705b272db4006ee81f7f125f53db66/98309/images/elements/openapi.svg
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.