https://github.com/andrew-boutin/broc-api
Bring your own controller DropWizard API.
https://github.com/andrew-boutin/broc-api
docker docker-compose dropwizard maven redis swagger
Last synced: 3 months ago
JSON representation
Bring your own controller DropWizard API.
- Host: GitHub
- URL: https://github.com/andrew-boutin/broc-api
- Owner: andrew-boutin
- Created: 2018-12-21T00:27:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-07T01:09:13.000Z (over 7 years ago)
- Last Synced: 2025-02-12T18:31:37.641Z (over 1 year ago)
- Topics: docker, docker-compose, dropwizard, maven, redis, swagger
- Language: Java
- Homepage: https://andrewboutin.com
- Size: 111 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BROC API
Bring Your Own Controller API
## Build and Run
Requires `maven` and `docker`.
```bash
$make
```
Go to `http://localhost:8000/swagger-ui/` to see a list of endpoints, and auto generate `curl` commands to test out the API.
Health checks are exposed at `http://localhost:8001/healthcheck`.
Environment variables can be specified, with the Docker run command, that the application will utilize. For example the application config file optionally allows you to specify the ports.
```bash
$docker run -it -p 8000:9000 -p 8001:8001 -e BROC_API_PORT=9000 broc-api-app
```
## Technology
This API leverages the [Dropwizard](https://www.dropwizard.io/1.3.5/docs/) framework.
It utilizes [Redis](https://redis.io/) as a data store. [Redis Commander](https://joeferner.github.io/redis-commander/) is also set up.
It uses [Maven](https://maven.apache.org/) as the build tool. The project is broken out into submodules.
[Docker](https://www.docker.com/) and [Docker Compose](https://docs.docker.com/compose/) are used for containerization. [Makefile](https://www.gnu.org/software/make/manual/html_node/Introduction.html) is used for command automation.
The API is defined by a [Swagger](https://swagger.io/) spec. The app also hosts a Swagger UI at `/swagger-ui/`. Either run the app and go to `/swagger-ui/` or drop the [BROC API spec](broc-api-spec/api.yml) into the online [Swagger Editor](https://editor.swagger.io/) to see details on the API design.