Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: added RunIt README.md #815

Merged
merged 1 commit into from
Sep 15, 2021
Merged

docs: added RunIt README.md #815

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions packages/run-it/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# RunIt

**RunIt** is a React-based specification-driven REST API request tester.

Looker's [API Explorer](https://github.com/looker-open-source/sdk-codegen/tree/main/packages/api-explorer) uses the **RunIt** package for testing API endpoints.

A configuration provider interface enables **RunIt** to work both in the [Looker Extension Framework](https://docs.looker.com/data-modeling/extension-framework/extension-framework-intro) runtime environment and as a stand-alone browser application.

OAuth and CORS [are used](https://github.com/looker-open-source/sdk-codegen/blob/main/docs/cors.md) to authenticate and submit REST requests for the stand-alone version.

## RunIt tabs

The [RunIt](src/RunIt.tsx) component has multiple tabs:

### Request

The Request tab displays a form for entering inputs to the chosen REST API endpoint

### Response

API responses are displayed on this tab. Support for rendering a variety of API response types like as JSON, CSV, Markdown, JPEG, HTML, PNG, and SQL are supported.

### SDK Call

The language SDK calling syntax provided by the Looker codegen project (also in this repository) is shown on this tab.

### Performance

Only for the stand-alone version, some performance information for HTTP request and response processing is shown here.

### Configuration

Only for the stand-alone version, this tab is used to configure the OAuth server for API request tokens.

## Using RunIt

See the [stand-alone API Explorer](https://github.com/looker-open-source/sdk-codegen/tree/main/packages/api-explorer/src/StandaloneApiExplorer.tsx) and the [extension version of API Explorer](https://github.com/looker-open-source/sdk-codegen/tree/main/packages/extension-api-explorer/src/ExtensionApiExplorer.tsx) for reference implementations.