Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

API docs on swagger

This folder contains everything to build and run the Swagger UI for browsing the API documentation.

As a prerequisite, the cyberagent/typebook:latest image needs to be available locally - it can be built from the project root (the directory containing build.sbt) as follows:

$ sbt docker

The Swagger UI can then be started as follows:

$ docker-compose up

Access http://$DOCKER_HOST:8080 in a browser and explore http://$DOCKER_HOST:8080/typebook.yml as shown below. $DOCKER_HOST is address of your docker host.

2017-06-19 11 42 32