Web App

Use Echolon directly in your browser — no installation required.

Overview

The Echolon web app lets you test APIs from any device with a modern browser. Access it at app.echolon.app.

Features

  • No installation required
  • Works on any modern browser (Blink (Chrome) recommended)
  • Same UI as the desktop app
  • No Mocking (on the roadmap)
  • File system access via the web File System Access API

Limitations

Due to browser security restrictions, some features have limitations:

  • CORS restrictions may require a proxy for some APIs
  • Limited offline support

Embedding Echolon

Embed Echolon as an interactive API reference directly into your website or documentation. Load your OpenAPI specification and provide users with a beautiful, interactive API explorer.

Basic Example

Here's a minimal example that loads an OpenAPI spec and displays it in reference mode:

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>My API Reference</title>
</head>
<body>
  <!-- Container where Echolon will be mounted -->
  <div id="echolon"></div>
  
  <!-- Configuration via data attributes -->
  <script
    id="api-reference"
    data-url="https://sample-api.echolon.app/openapi.json"
    data-theme="dark"
    data-view="reference"
    data-readonly="true"
    data-title="My API Reference"
  ></script>
  
  <script src="https://cdn.jsdelivr.net/gh/echolon-app/echolon@v1.1.1/web/dist/echolon-web.es.js"></script>
</body>
</html>

Configuration Options

Configure Echolon using data-* attributes on the script tag:

Attribute Description Default
data-url URL to your OpenAPI/Swagger specification (JSON or YAML). The spec is fetched and parsed automatically to generate the API reference.
data-theme Color theme. Options: light, dark, or system (follows OS preference). system
data-view Default view mode. reference shows all endpoints in a scrollable list. tabs shows the standard tabbed interface. reference
data-readonly When set to true or empty, hides editing controls. Users can still test requests but cannot modify the collection structure. false
data-title Custom title displayed in the header. Overrides the title from the OpenAPI spec. Spec title
data-versions-url URL to a JSON endpoint returning available API versions. Enables a version switcher in the UI.