Want to build an awesome developer portal?

Need to better integrate API documentation into your API design workflow?

Introducing Elements, free open-source API Documentation that you can embed anywhere that accepts HTML and JavaScript, with support for OpenAPI (v3.1, v3.0 and v2.0!) and Markdown.

Available as React Components, or Web Components, you can use Elements to create beautiful three-column documentation, or stacked documentation that is easy to integrate into existing Content Management Systems with their own navigation.

Whether you have an existing developer portal, or are creating your own, you can use these components to add automatically generated API reference documentation that fits in seamlessly. Use these UI components to create API reference documentation, and sprinkle in some more complete documentation with Markdown articles covering tutorials, how-to guides, and more.

🔗 What makes Elements such a powerful documentation tool?

  • Powered by OpenAPI: Elements leverages OpenAPI and JSON Schema so that you can create beautiful, templated documents for even the most dynamic payloads.
  • Interactive API Console: Get started faster with built-in test requests and responses within the documentation.
  • Code Samples: Kickstart integration with code samples in popular languages like Java, Ruby, and Go.
  • Enhanced Markdown Support: Write rich tutorials and descriptions with Stoplight-flavored Markdown to add tabs, callouts, embed JSON examples, and more
  • Easy to Set Up: No build steps so you can get started in minutes. Elements is built on web components, so creating API documentation is as easy as adding a HTML tag within your project, and can be used with any framework.
  • Delightful DX: Help developers find and consume your APIs faster, with a visual experience similar to the much loved Stripe API Documentation.
  • Moving is Easy: Stoplight Elements combines a great developer experience with best in class OpenAPI documentation. Moving from Redoc or Swagger-UI to Stoplight Elements is painless.

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 documents or to projects in your Stoplight Workspace.

  • Stoplight Studio: Elements works with our free visual OpenAPI designer to preview your API descriptions on the fly.
  • Stoplight Platform: Document APIs powered by Elements throughout the collaborative design process in our API design, development, and documentation platform.

Sign up today to become an Early Access tester for our Elements DevPortal Pre-Release and start building beautiful API docs wherever you need them.

Peek-a-Boo (1)

Subscribe for the latest in API Design

By submitting this you will be receiving our latest updates on post.

Take a Listen to API Intersection

The podcast on the intersection between API design & digital transformation

Related Posts