44 lines
2.0 KiB
Markdown
44 lines
2.0 KiB
Markdown
# Auth API
|
|
|
|
A tiny REST API for auth. Register accounts, auth with api-key or name/password, renew JWT tokens...
|
|
|
|
## Quick start with docker compose
|
|
|
|
Migrate database: `docker-compose run --rm db-migrations`
|
|
|
|
Start the API (on port 4000 by default): `docker-compose up -d`
|
|
|
|
Point your browser to `http://localhost:4000` to view the swagger API documentation.
|
|
|
|
## Admin account
|
|
|
|
On first startup with a clean database, an account with name "admin" and the field "role" with a value "admin" is created with no password, using the API Key from ADMIN_API_KEY in the .env file.
|
|
|
|
## Special account field: "role"
|
|
|
|
The account field "role" is a bit special, in that if it contains "admin" as one of its values, that grants access to all methods on all accounts on this service. It might be a good idea to use the field "role" for authorization throughout your services.
|
|
|
|
## Tests
|
|
|
|
Run integration tests (Requires migrated database and started API): `docker-compose run --rm tests`
|
|
|
|
## Deploy a new version
|
|
|
|
Everytime a push is done, tests are ran on [Drone](https://drone.larvit.se/pwrpln/auth-api). To deploy a new version to [Dockerhub](https://hub.docker.com/repository/docker/lilleman/auth-api), create a new tag (USE SEMVER!!!).
|
|
|
|
## Some useful cURLs
|
|
|
|
Obtain an admin GWT: `curl -d '"api-key-goes-here"' -H "Content-Type: application/json" -i http://localhost:4000/auth/api-key`
|
|
|
|
Use a bearer token to make a call: `curl -H "Content-Type: application/json" -H "Authorization: bearer your-JWT-token-goes-here" -i http://localhost:4000/accounts/{accountID}`
|
|
|
|
Create account: `curl -d '{"name": "Bosse", "password": "Hemligt", "fields": [{ "name":"role", "values":["user"]}]}' -H "Content-Type: application/json" -H "Authorization: bearer your-JWT-token-goes-here" -i http://localhost:4000/account`
|
|
|
|
## Development
|
|
|
|
For local development, run with .env like: `eval $(cat .env) go run src/main.go`
|
|
|
|
To regenerate the swagger docs folder:
|
|
|
|
1. Make sure you have swag installed: https://github.com/swaggo/swag
|
|
2. cd src && swag init |