joshuamarquez/api-console-server repository overview

⁠docker-api-console-server

Docker api-console⁠ NGINX based server to render your RAML docs.

⁠Install

$ docker pull joshuamarquez/api-console-server

⁠Quick example

$ docker run -p 8080:80 -d joshuamarquez/api-console-server

then go to localhost:8080⁠ and you will see the example RAML API.

⁠Use own RAML files

This image will load RAML file api.raml located inside container at /api-console/raml, so to replace it and even add your own RAML files structure just mount a VOLUME like below.

$ docker run -v $(pwd):/api-console/raml -p 8080:80 -d joshuamarquez/api-console-server

Notes

• For the command above to work, a RAML file named api.raml should exists in the directory were command was ran and the same for any types, traits, securitySchemes, resourceTypes, etc.
• For development you can use docker-api-console⁠.

⁠Logging

• Access Log is located at /api_console_server_access.log
• Error Log is located at /api_console_server_error.log.