Check it out: madr.space
alias swagger='docker run --rm -it --user $(id -u):$(id -g) -e GOCACHE=/tmp -e GOPATH=$(go env GOPATH):/go -v $HOME:$HOME -w $(pwd) quay.io/goswagger/swagger'
swagger generate spec -o ./swagger.yaml --scan-models
docker-compose up --build
By default, service is available at http://localhost:8080
.
- Install go-swagger. It's necessary since the service uses swagger-generated file for hosting documentation.
- Run
make run
in the root of the project.
Service documentation is available at /api/docs
after starting the service.
By default, it's available at http://localhost:8080/api/docs
. It contains a rich description of endpoints and models.