| commit | da45af5bb1716d46e56d756991ce1c8bd51367d8 | [log] [tgz] |
|---|---|---|
| author | Scott Ganyo <scott@ganyo.com> | Tue Oct 25 08:09:12 2016 -0700 |
| committer | Scott Ganyo <scott@ganyo.com> | Tue Oct 25 08:09:12 2016 -0700 |
| tree | abd552b0854efe62fb22d0bdde07b72fbba1068c | |
| parent | 02334b1619d79408d33d41799cf666841062c08e [diff] |
Update docs
This core plugin for apid responds to apidApigeeSync events and publishes an API that allows clients to deploy and update a locally configured gateway.
This plugin simply tracks counters based on called URIs:
GET /deployments/current - retrieve current deploymentPOST /deployments/{id} - update specified deploymentFirst, install prerequisites:
glide install
To run an apid test instance with just this plugin installed, change to the cmd/apidGatewayDeploy folder. From here, you may create an executable with:
go build
Alternatively, you may run without creating an executable with:
go run main.go
Command line options:
If you use the -manifest option, the server will start using a clean database that contains only the deployment manifest specified.
Once the process is running, you should be able to manually give the plugin's API a whirl...
curl -i localhost:9000/deployments/current
curl -i -X POST localhost:9000/deployments/entityId -d '{ "status": "SUCCESS" }'
The following have been exposed as configurable env vars:
To run the tests, just run:
go test
To generate coverage, you may run:
./cover.sh
Then open cover.html with your browser to see details.