{"id":23278459,"url":"https://github.com/andrew-boutin/broc-api","last_synced_at":"2026-04-09T12:04:55.223Z","repository":{"id":82226233,"uuid":"162645359","full_name":"andrew-boutin/broc-api","owner":"andrew-boutin","description":"Bring your own controller DropWizard API.","archived":false,"fork":false,"pushed_at":"2019-02-07T01:09:13.000Z","size":114,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-12T18:31:37.641Z","etag":null,"topics":["docker","docker-compose","dropwizard","maven","redis","swagger"],"latest_commit_sha":null,"homepage":"https://andrewboutin.com","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrew-boutin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-12-21T00:27:23.000Z","updated_at":"2019-02-07T01:09:16.000Z","dependencies_parsed_at":"2023-06-25T23:12:56.309Z","dependency_job_id":null,"html_url":"https://github.com/andrew-boutin/broc-api","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrew-boutin%2Fbroc-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrew-boutin%2Fbroc-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrew-boutin%2Fbroc-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrew-boutin%2Fbroc-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrew-boutin","download_url":"https://codeload.github.com/andrew-boutin/broc-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247485281,"owners_count":20946397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","docker-compose","dropwizard","maven","redis","swagger"],"created_at":"2024-12-19T22:31:33.176Z","updated_at":"2025-12-30T21:28:46.465Z","avatar_url":"https://github.com/andrew-boutin.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# BROC API\n\nBring Your Own Controller API\n\n![cool-broccoli](cool-broccoli.png)\n\n## Build and Run\n\nRequires `maven` and `docker`.\n\n```bash\n$make\n```\n\nGo to `http://localhost:8000/swagger-ui/` to see a list of endpoints, and auto generate `curl` commands to test out the API.\n\nHealth checks are exposed at `http://localhost:8001/healthcheck`.\n\nEnvironment 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.\n\n```bash\n$docker run -it -p 8000:9000 -p 8001:8001 -e BROC_API_PORT=9000 broc-api-app\n```\n\n## Technology\n\nThis API leverages the [Dropwizard](https://www.dropwizard.io/1.3.5/docs/) framework.\n\nIt utilizes [Redis](https://redis.io/) as a data store. [Redis Commander](https://joeferner.github.io/redis-commander/) is also set up.\n\nIt uses [Maven](https://maven.apache.org/) as the build tool. The project is broken out into submodules.\n\n[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.\n\nThe 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrew-boutin%2Fbroc-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrew-boutin%2Fbroc-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrew-boutin%2Fbroc-api/lists"}