api-gateway

command module
v0.0.0-...-88c5504 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 19, 2019 License: MPL-2.0 Imports: 1 Imported by: 0

README

API Gateway

master: CircleCI
develop: CircleCI

This service expose REST endpoints to each of the datastores inside of ernest. Requests are translated from http calls to nats requests.

Installation

make deps
make install

Running Tests

make deps
go test

Authentication

Authentication is handled by JWT. You must first authenticate via /auth/ and use the returned web token as a header in all subsequent requests.

curl -i -X POST -d "username=something" -d "password=something" localhost:8080/auth/

This will return the following json payload:

{"token":"VALID-AUTH-TOKEN"}

This then can be used in subsequent requests, like so:

curl -i -H 'Authorization: Bearer VALID-AUTH-TOKEN' localhost:8080/api/users/

Endpoints

Supported endpoints are Users, Groups, Datacenters and Services.

Contributing

Please read through our contributing guidelines. Included are directions for opening issues, coding standards, and notes on development.

Moreover, if your pull request contains patches or features, you must include relevant unit tests.

Versioning

For transparency into our release cycle and in striving to maintain backward compatibility, this project is maintained under the Semantic Versioning guidelines.

Code and documentation copyright since 2015 ernest.io authors.

Code released under the Mozilla Public License Version 2.0.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL