In simple English
Building a clear manual for your software interface takes a lot of time. This tool turns your interface description into a clean, readymade website. Visitors can read about your endpoints and test them right in the browser. You add a few lines of code to your project to make it work. The software is free to use and open source.
What it is
Elements is a set of UI components that turns OpenAPI specifications into interactive documentation. It runs either as a React component or as a standalone web component inside any HTML page.
What it is good for
Solo builders who need to publish clean API documentation for their users without setting up a heavy documentation server.
- Creates a clean three-column layout similar to popular developer portals.
- Includes a built-in console so users can test requests directly in the browser.
- Works inside plain HTML files or React applications.
- Requires an existing OpenAPI file describing your endpoints.
- Uses Scarf analytics during installation unless you explicitly opt out.
- The latest stable release is several years old, though the repository receives occasional code updates.
writing custom API documentation pages by hand
Swagger UI
- swagger-api/swagger-ui29k stars
Generates browser-based API documentation from OpenAPI files with a different visual style.
- Redocly/redoc26k stars
Another popular alternative for rendering OpenAPI definitions into a three-column documentation site.
- facebook/docusaurus67k stars
A static site generator from Meta that turns Markdown files into a documentation website.
- mkdocs/mkdocs23k stars
Turns a folder of Markdown files into a documentation website, controlled by one settings file.
- squidfunk/mkdocs-material28k stars
Turns a folder of Markdown files into a searchable documentation website, with every formerly sponsor-only feature now included.
npm install @stoplight/elements