Stoplight Elements is an open-source API documentation component library for rendering OpenAPI specifications interactively. It provides embeddable React and Web Components that produce beautiful, interactive API reference documentation from any OpenAPI 2.0, 3.0, or 3.1 document.
- Website: https://stoplight.io/open-source/elements
- GitHub: https://github.com/stoplightio/elements
- npm: https://www.npmjs.com/package/@stoplight/elements
- Documentation: https://docs.stoplight.io/docs/elements
Elements renders OpenAPI specifications as interactive developer documentation with a sidebar layout, stacked layout, or responsive layout. It includes a built-in Try It console for testing API requests directly from the documentation, auto-generated code samples in multiple languages, schema visualization, and support for filtering internal operations.
Elements is available as:
- React components via
@stoplight/elements - Web Components (Custom Elements) loadable from CDN or npm via
@stoplight/elements/web-components
| File | Type | Description |
|---|---|---|
openapi/elements-elements-openapi.yml |
OpenAPI | Component props and configuration surface as an OpenAPI spec |
json-schema/elements-configuration-schema.json |
JSON Schema | JSON Schema for all Elements configuration props |
json-ld/elements-context.jsonld |
JSON-LD | Linked data context for Elements entities |