This project can be used to automatically generate web based documentation for RAML Service Contracts.
Depending on your development environment, you will need either Docker or Git and Node.js (^8.10.0)
to be properly installed on your computer before api-console-builder can be run.
- Navigate to the directory containing your RAML Service Contract.
- Execute api-console-builder by running the following command:
sudo docker run --init --rm --volume $(pwd):/usr/src/app/api-source "mikeyryan/api-console-builder:latest"
Note: api-console crashes if it does not have enough memory. To work reliably, you need to ensure docker has access to at least 4gb of memory.
- Clone the source code repository:
git clone https://github.com/Mike-Gough/api-console-builder
- Navigate to the cloned folder:
cd api-console-builder
- Install the project dependancies using NPM:
npm install
- Execute api-console-builder by running the following command:
node --max-old-space-size=4096 build.js <raml-source-path> <destination-path> <main-file-name>