Stoplight Elements website screenshot

Stoplight Elements

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, with support for a Try It console, code sample generation, sidebar and stacked layouts, and internal operation filtering.

1 APIs 0 Features
API DocumentationDeveloper ToolsDocumentationInteractive DocsOpenAPIReactWeb Components

APIs

Stoplight Elements

Stoplight Elements is an open-source API documentation component library that renders OpenAPI 2.0, 3.0, and 3.1 specifications as beautiful, interactive developer documentation....

Collections

Pricing Plans

Elements Plans Pricing

3 plans

PLANS

Rate Limits

Elements Rate Limits

5 limits

RATE LIMITS

FinOps

Semantic Vocabularies

Elements Context

0 classes · 7 properties

JSON-LD

Resources

🔗
LinkedIn
LinkedIn
🔗
Documentation
Documentation
👥
GitHub
GitHub
🔗
npm
npm
🔗
CDN
CDN
🚀
GettingStarted
GettingStarted
🚀
GettingStarted
GettingStarted
🚀
GettingStarted
GettingStarted
🔗
Reference
Reference
🔗
Website
Website
📄
ChangeLog
ChangeLog
🔗
License
License
🔗
JSONSchema
JSONSchema
🔗
JSONLD
JSONLD

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Stoplight Elements API
  version: 8.0.0
items:
- info:
    name: Integration
    type: folder
  items:
  - info:
      name: Get Stoplight Elements Overview
      type: http
    http:
      method: GET
      url: https://stoplight.io/open-source/elements
    docs: Returns the Stoplight Elements open-source landing page describing the component library, its features, supported
      standards, and links to getting started guides and documentation.
  - info:
      name: Stoplight Elements Get Elements Documentation
      type: http
    http:
      method: GET
      url: https://stoplight.io/docs/elements
    docs: Returns the main Elements documentation landing page with links to getting started guides for React, Web Components,
      and Angular, as well as the full configuration options reference.
  - info:
      name: Stoplight Elements Get React Integration Guide
      type: http
    http:
      method: GET
      url: https://stoplight.io/docs/elements/b074dc07b3bae-getting-started-with-elements-in-react
    docs: Returns the getting started guide for integrating Stoplight Elements as React components. Covers installation of
      @stoplight/elements, importing the API component, providing an apiDescriptionUrl or apiDescriptionDocument prop, choosing
      a layout, and configuring the router prop.
  - info:
      name: Stoplight Elements Get Web Component Integration Guide
      type: http
    http:
      method: GET
      url: https://stoplight.io/docs/elements/19a7f9f0cbf23-getting-started-with-web-component
    docs: Returns the getting started guide for embedding Stoplight Elements as a Web Component (Custom Element) via CDN or
      npm. Covers including the web-components bundle, using the elements-api custom element tag in HTML, and setting attributes
      for apiDescriptionUrl, router, and layout.
  - info:
      name: Stoplight Elements Get Angular Integration Guide
      type: http
    http:
      method: GET
      url: https://stoplight.io/docs/elements/507fb7fab9b7d-getting-started-with-elements-in-angular
    docs: Returns the getting started guide for integrating Stoplight Elements into an Angular application, covering the CUSTOM_ELEMENTS_SCHEMA
      import, component registration, and attribute binding.
- info:
    name: Configuration
    type: folder
  items:
  - info:
      name: Stoplight Elements Get Configuration Options Reference
      type: http
    http:
      method: GET
      url: https://stoplight.io/docs/elements/ZG9jOjMyNjU5MTM-elements-configuration-options
    docs: Returns the complete reference page for all Stoplight Elements configuration props and Web Component attributes,
      including apiDescriptionUrl, apiDescriptionDocument, layout, router, basePath, hideTryIt, hideTryItPanel, hideSamples,
      hideSchemas, hideInternal, hideExport, hideServerInfo, hideSecurityInfo, tryItCredentialsPolicy, tryItCorsProxy, maxRefDepth,
      logo, and outerRouter.
bundled: true