This is a simple task, to integrate some json data with mongodb and create an API end point using go to get this data A few things to note in the project:
- Github Actions Workflows - Pre-configured Github Actions to run automated builds and publish image to Github Packages
- Dockerfile - Dockerfile to generate docker builds.
- docker-compose - Docker compose script to start service in production mode.
- Containerized Mongo for development - Starts a local mongo container with data persistence across runs.
- Mongo Driver - MongoDB supported driver for Go.
- Gorilla Mux - HTTP request multiplexer.
- .env file for configuration - Change server config like app port, mongo url etc
- httptest - Utilities for HTTP testing.
$ git clone git@github.com:abdolrhman/simple-go-api.git
$ cd simple-go-api.git
$ go mod vendor
- a function run every time the application starts
- fill the database with the records on the josn
- if no any
- API that grapes the data from mongodb
- The API accepts parameters if given, that creat that construct the query options
- nginx and workflow supported
- integration test supported
Starting the dev server also starts MongoDB as a service in a docker container using the compose script at docker-compose.yml.
$ go run main.go
Running the above commands results in
- 🌏 API Server running at
http://localhost:8080
- ⛁ MongoDB running at
mongodb://localhost:27017/wajve
$ go build
$ cd tests
$ go test
$ docker build -t api-server .
$ docker run -t -i -p 8080:8080 api-server
$ docker-compose up
To edit environment variables, create a file with name .env and copy the contents from .env.default to start with.
| Var Name | Type | Default | Description |
|---|---|---|---|
| PORT | number | 8080 |
Port to run the API server on |
| MONGO_URL | string | mongodb://localhost:27017/wajve |
URL for MongoDB |
+-- controllers
| +-- triviaController.go
+-- db
| +-- db.go
| +-- db.json
+-- handlers
| +-- config.go
| +-- logs.go
| +-- response.go
+-- models
| +-- models.go
+-- tests
| +-- api_test.go
+-- routes
| +-- routes.go
+-- vendor
+-- nginx
| +-- dev.conf.d
| | +-- nginx.conf
+-- .env
+-- .env.default
+-- .gitignore
+-- docker-compose.yml
+-- Dockerfile
+-- go.mod
+-- go.sum
+-- main.go
+-- README.md