@looker/api-explorer

OpenAPI Explorer

Use this OpenAPI Explorer to read any OpenAPI specification and explore its methods and types. Fast and powerful searching is also supported.

This is an Open Source project that builds on the specification processing created in the Looker SDK Codegen project.

Getting started

This package uses Yarn. See the Yarn installation instructions if you need to install it.

To install dependencies, run:

yarn install

followed by:

NOTE: For API-explorer to build all other packages must have been built at least once. Use yarn build to do a complete build.

yarn workspace @looker/api-explorer develop

will start the development server and monitor for changes.

To see the other scripts supported by the package, do

yarn workspace @looker/api-explorer run

Running E2E Tests

The API Explorer includes end-to-end tests using Puppeteer.

Run Local Tests

This command will automatically start the development server (yarn develop) and run the tests against it.

yarn workspace @looker/api-explorer run test:e2e

E2E Testing

To run the E2E tests against a remote Looker instance, you must provide your API client credentials.

Run Remote E2E Tests

This runs the local development server (with your code changes) but proxies API requests to the remote Looker instance.

API_PROXY_TARGET=https://<your-looker-instance> \
LOOKER_CLIENT_ID=<your-client-id> \
LOOKER_CLIENT_SECRET=<your-client-secret> \
yarn workspace @looker/api-explorer run test:e2e