Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.05 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.05 KB
Raw

AuthDCOS

Golang backend for DC/OS authorization

TODO: put build status here

Installation

Prerequisites

  • Go 1.6

Once the environment is set for Go, run make to compile and make install to install.

Tests

Running make test will build the docker image authdcos and run tests in the test directory. The API integration tests will run two containers:

  • authdcos-zk
  • authdcos-api

then send a request with the available HTTP methods for the API routes. Please refer to /api/routes.go for more details.

HTTP API specification

The file docs/apispec-swagger.json specifies the behavior bouncer's HTTP API, using Swagger 2.0 notation.

For ease of viewing, the contents of apispec-swagger.json can be pasted into the Swagger editor — resulting in a useful and beautiful HTML live-rendering of the API specification. Note that the HTML output does not necessarily contain all detail specified in the JSON file.

License

Apache License 2.0