app-exposer is a service for the CyVerse Discovery Environment that provides a CRUD API for managing VICE analyses.
just- A command runner, similar to but different from Make. See just for more info.go- The Go programming language. See Go for more info.swag- A Swagger 2.0 documentation generator for Go. See swag for more info.
You will need just installed, along with the Go programming language and the bash shell.
To build app-exposer alone, run:
just app-exposerTo build workflow-builder alone, run:
just workflow-builderTo build both, run:
justTo clean your local repo, run:
just cleanUses Go modules, so make sure you have a generally up-to-date version of Go installed locally.
The API documentation is written using the OpenAPI 3 specification and is located in api.yml. You can use redoc to view the documentation locally:
Install:
npm install -g redoc-cli
Run:
redoc-cli serve -w api.yml
For configuration, use example-config.yml as a reference. You'll need to either port-forward to or run job-status-listener locally and reference the correct port in the config.
The command used to initialize the ./docs directory with the swag tool was
swag init -g app.go -d cmd/app-exposer/,httphandlers/The General Info file for swag is cmd/app-exposer/main.go.