Registry / web-framework / loopback-component-explorer

loopback-component-explorer

JSON →
library6.5.1jsnpmunverified

loopback-component-explorer is a utility for LoopBack 3 applications, providing an interactive UI to browse and test API endpoints. It is currently at version 6.5.1 and is intrinsically linked to LoopBack 3, which is in "Maintenance LTS mode." This means the component itself receives only critical bug fixes and security patches, with no new feature development. Its primary function is to render the API specification using an embedded `swagger-ui` (version 2.x), enabling developers to visualize and interact with their API routes directly within the browser. Its release cadence is sporadic, tied to critical fixes for the EOL LoopBack 3 framework. A key differentiator is its seamless integration into the LoopBack 3 ecosystem, acting as the standard API documentation and testing tool for that framework generation. Users are strongly encouraged to migrate to LoopBack 4, which uses a different explorer component.

web-frameworkhttp-networking
github ↗package ↗
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

Primarily used in CommonJS environments with LoopBack 3, the `explorer` variable then becomes a function to register the component.

const explorer = require('loopback-component-explorer');

The `routes` method is a property of the main `loopback-component-explorer` export, used to mount the explorer as Express middleware.

explorer.routes(app, { basePath: '/api' });

Demonstrates how to initialize a basic LoopBack 3 application and mount the API Explorer at a specified path, exposing a simple 'Product' model.

var loopback = require('loopback'); var app = loopback(); var explorer = require('loopback-component-explorer'); var port = 3000; var Product = loopback.Model.extend('product'); Product.attachTo(loopback.memory()); app.model(Product); app.use('/api', loopback.rest()); // Register explorer using component-centric API: explorer(app, { basePath: '/api', mountPath: '/explorer' }); // Alternatively, register as a middleware: // app.use('/explorer', explorer.routes(app, { basePath: '/api' })); console.log("Explorer mounted at localhost:" + port + "/explorer"); app.listen(port);
Debug
Known footguns
breakingLoopBack 3, for which `loopback-component-explorer` is designed, is in Maintenance LTS mode. This means only critical bugs and security fixes will be provided, and users are strongly urged to migrate to LoopBack 4.
breakingVersion 3.0.0 of this component reverted to using the original `swagger-ui` module instead of a previously used custom fork. This change might subtly alter UI behavior, available features, or styling, as upstream fixes and improvements from `swagger-ui` were integrated.
gotchaThe component is built on `swagger-ui` version 2.x, which is no longer maintained and has known security vulnerabilities (e.g., Cross-Site Scripting, Reverse Tabnapping, CSS injection, CVE-2019-17495). While `loopback-component-explorer` states it mitigates some specific advisories due to its limited usage patterns, the underlying dependency remains outdated and could pose risks.
gotchaThis component is specifically designed for LoopBack 3 applications. It is not compatible with LoopBack 4, which has its own modular and OpenAPI-driven explorer components.
Upgrade
Version history

Breaking-change detection hasn't run for this library yet.

Audit
Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity
0 hits · last 30 days

No traffic data recorded yet.

Resources
githubhttps://github.com/strongloop/loopback-component-explorer ↗
packagehttps://www.npmjs.com/package/loopback-component-explorer ↗