# api-ui
**Repository Path**: powerpaas/api-ui
## Basic Information
- **Project Name**: api-ui
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-12-02
- **Last Updated**: 2020-12-19
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
api-ui
========
An embedded UI for any service that implements the Rancher API spec.
Integrating with your API
-------
See [HTML UI](https://github.com/rancherio/api-spec/blob/master/specification.md#html-ui) in the API specification. This also includes a link to the latest version hosted on our CDN.
Install
--------
```bash
git clone https://github.com/rancherio/api-ui
cd api-ui
npm install
```
Usage
--------
### Compiling into stand-alone CSS and JavaScript files
This will write files to `./dist/{version}/`, suitable for publishing to a CDN.
```bash
./scripts/build
```
### Running as a standalone server
This will start a server on the given port number (default: 3000) that serves up the assets directly.
This mode is mostly suitable for development of this library itself.
```bash
./scripts/serve
```
Integrating with an API
--------
Wrap JSON responses with a bit of HTML (and return `Content-Type: text/html`):
```html
```
Options
------
Several options can be configured through additional globals:
```javascript
// Adds a documentation link in the navigation area
var docsPage = "http://url-to-your-docs/site";
// URL to a documentation JSON file to add descriptions for types and fields.
var docsJson = "http://url-to-your-docs.json";
// Displays the username who is logged in next to the Log Out link so the user knows who you think they are
var user = "jsmith";
// Disables the display of the logout link
var logout = false; // Disable the display of the Log Out link
// Replaces the default "${API_ACCESS_KEY}:${API_SECRET_KEY}" string when displaying cURL commands.
// setting to false will omit the user/pass option from the command entirely.
var curlUser = "some:thing";
// Overrides the location where bootstrap is loaded from ('/css/boostrap.min.css' and '/js/bootstrap.min.js' will be appended to this)
var bootstrap = "http://url/to/bootstrap/version";
```
### Bugs & Issues
Please submit bugs and issues to [rancher/rancher](//github.com/rancher/rancher/issues) with a title starting with `[API UI] `.
Or just [click here](//github.com/rancher/rancher/issues/new?title=%5BAPI%20UI%5D%20) to create a new issue.