https://github.com/danwakeem/loopback-rest-explorer-auth

LoopBack's API Explorer with Authentication Header
https://github.com/danwakeem/loopback-rest-explorer-auth

Last synced: about 6 hours ago
JSON representation

LoopBack's API Explorer with Authentication Header

• Host: GitHub
• URL: https://github.com/danwakeem/loopback-rest-explorer-auth
• Owner: Danwakeem
• License: other
• Created: 2018-12-15T14:52:33.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T09:02:05.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T18:12:30.463Z (8 days ago)
• Language: TypeScript
• Size: 461 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @loopback/rest-explorer

This module contains a component adding a self-hosted REST API Explorer to

LoopBack applications.

## Installation

```sh

npm install --save @loopback/rest-explorer

```

## Basic use

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.

Start by importing the component class:

```ts

import {RestExplorerComponent} from '@loopback/rest-explorer';

```

In the constructor, add the component to your application:

```ts

this.component(RestExplorerComponent);

```

By default, API Explorer is mounted at `/explorer`. This path can be customized

via RestExplorer configuration as follows:

```ts

this.bind(RestExplorerBindings.CONFIG).to({

  path: '/openapi/ui',

});

```

_NOTE: The Explorer UI's visual style is not customizable yet. Our recommended

solution is to create a fork of this module, make any style changes in the fork

and publish the modified module under a different name. The

[GitHub issue #2023](https://github.com/strongloop/loopback-next/issues/2023) is

requesting a configuration option for customizing the visual style, please

up-vote the issue and/or join the discussion if you are interested in this

feature._

## Contributions

- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)

- [Join the team](https://github.com/strongloop/loopback-next/issues/110)

## Tests

Run `npm test` from the root folder.

## Contributors

See

[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).

## License

MIT