https://github.com/ramiawar/gin-gonic-demo
Example Golang web application with Gin Gonic
https://github.com/ramiawar/gin-gonic-demo
Last synced: 7 months ago
JSON representation
Example Golang web application with Gin Gonic
- Host: GitHub
- URL: https://github.com/ramiawar/gin-gonic-demo
- Owner: RamiAwar
- Created: 2022-08-16T10:35:11.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-08-17T08:58:46.000Z (about 3 years ago)
- Last Synced: 2025-03-23T18:51:49.104Z (7 months ago)
- Language: Go
- Size: 24.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gin Golang Demo Project
Opinionated example Golang web application with Gin Gonic.
Builds upon https://github.com/RamiAwar/go_demo_users_api.
## Build and run with Docker
```bash
docker build -t gin-demo:latest .
docker run -p 3000:3000 gin-demo
```
## Build and run with Go
```bash
go mod tidy
go run ./main.go
```
## DNS endpoint example:
```bash
❯ curl -X POST localhost:3000/v1/dns/find -H 'Content-Type: application/json' -d '{"x": "123.12", "y": "456.56", "z": "789.89", "vel": "20.0"}'
```
## Running the tests
```bash
go test ./...
```
## Understanding the structure
Check out my blog post on backend route design for an in depth dive into the structure: https://softgrade.org/in-depth-guide-to-backend-route-design/
### At a high level:
- routes: validation of requests, returning results, handling errors
- services: business logic, should not be concerned whatsoever with how they're used (ex. know nothing about HTTP or context)
- models: request models, response models, and everything in between goes here. Validation + default values are implemented as methods of those models.
- config, app: self explanatory
### Structural improvements:
Passing down context from requests to services is usually very useful. It is true that we want to isolate business logic from usecase, but in the case of web servers this is a very acceptable compromise as the context offers many advantages.