centurylink/panamax-api-docs repository overview

⁠Panamax API documentation

The Panamax API documentation is described by a Swagger 2.0 specification, and rendered by using the Swagger UI project. The Panamax API specifications are kept under the 'api-docs' folder.

To view the Panamax API docs, clone the repo, and run it as a website using any webserver.

⁠On OSX

You can easily do that by:

python -m SimpleHTTPServer 8000

and then browsing to:

http://localhost:8000

⁠Using Docker

We have deployed the Docker image on the Docker Hub⁠.

Simply run it by:

docker run -d --name api-docs -p 9000:80 centurylink/panamax-api-docs

Enjoy!