https://github.com/ioleo/api-console-docker

A Docker image to run the API Console for your REST API documentation with RAML.
https://github.com/ioleo/api-console-docker

api-console docker-image raml

Last synced: 7 days ago
JSON representation

A Docker image to run the API Console for your REST API documentation with RAML.

• Host: GitHub
• URL: https://github.com/ioleo/api-console-docker
• Owner: ioleo
• Created: 2017-02-26T17:50:59.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-04-11T23:29:47.000Z (over 7 years ago)
• Last Synced: 2024-10-30T09:26:36.595Z (about 2 months ago)
• Topics: api-console, docker-image, raml
• Language: RAML
• Homepage:
• Size: 3.91 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# API Console docker image

A [Docker](http://www.docker.io/) image to run the [API Console](https://github.com/mulesoft/api-console) for 

your REST API documentation with [RAML](http://raml.org).

## Installation

### Mounting volume

The image must be run from path containing RAML files or a directory containing such file must be mounted at

`/app/raml`.

### How to run this image

`docker run -p 4000:80 -v $(pwd)/raml:/app/raml -d loostro/api-console:3.0.13`

Then, access it via `http://localhost:4000` in a browser.

### Environment variables

* **MAIN_RAML_PATH** *string*, default: `main.raml`

* **PAGE_TITLE** *string*, default: `API Documentation`

### Options

API Console can be controlled by `/options.conf` file.

The file must be a simple `key=value` configuration, each key accepts string value either `true` or `false`:

* **singleView** default: `false`

* **disableThemeSwitcher** default: `true`

* **disableRamlClientGenerator** default: `true`

* **resourcesCollapsed** default: `true`

* **documentationCollapsed** default: `false`

* **allowUnsafeMarkdown** default: `false`

* **disableTryIt** default: `true`