UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

101 lines (50 loc) 1.7 kB
--- lang: en title: 'API docs: rest-explorer' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/packages/rest-explorer permalink: /doc/en/lb4/apidocs.rest-explorer.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/rest-explorer](./rest-explorer.md) ## rest-explorer package A LoopBack 4 component for adding a self-hosted REST API Explorer. ## Remarks The component should be loaded in the constructor of your custom Application class. Applications scaffolded by recent versions of our lb4 CLI tool have the self-hosted REST API Explorer pre-configured out of the box. ## Classes <table><thead><tr><th> Class </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [RestExplorerComponent](./rest-explorer.restexplorercomponent.md) </td><td markdown="1"> A component providing a self-hosted API Explorer. </td></tr> </tbody></table> ## Namespaces <table><thead><tr><th> Namespace </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [RestExplorerBindings](./rest-explorer.restexplorerbindings.md) </td><td markdown="1"> Binding keys used by this component. </td></tr> </tbody></table> ## Type Aliases <table><thead><tr><th> Type Alias </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [RestExplorerConfig](./rest-explorer.restexplorerconfig.md) </td><td markdown="1"> Options to configure API Explorer UI </td></tr> </tbody></table>