Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/learning-cloud-native-go/myapp
🚀 How to build a Dockerized RESTful API application using Go.
https://github.com/learning-cloud-native-go/myapp
cloud-native docker go golang kubernetes microservice restful-api tutorial
Last synced: 28 days ago
JSON representation
🚀 How to build a Dockerized RESTful API application using Go.
- Host: GitHub
- URL: https://github.com/learning-cloud-native-go/myapp
- Owner: learning-cloud-native-go
- License: mit
- Created: 2019-08-02T11:54:58.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-12T11:42:55.000Z (7 months ago)
- Last Synced: 2024-08-03T23:29:58.167Z (4 months ago)
- Topics: cloud-native, docker, go, golang, kubernetes, microservice, restful-api, tutorial
- Language: Go
- Homepage: https://learning-cloud-native-go.github.io
- Size: 66.4 MB
- Stars: 816
- Watchers: 19
- Forks: 65
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - myapp
README
[](https://www.buymeacoffee.com/dumindu)
# Learning Cloud Native Go - myapp
> 🌱 Cloud Native Application Development is one way of speeding up the building of web applications using microservices, containers, and orchestration tools.
This repository shows how to build a Dockerized RESTful API application in Go for a simple bookshelf.
## 🔋 Batteries included
- The idiomatic structure based on the resource-oriented design.
- The usage of Docker, Docker compose, Alpine images, and linters on development.
- Healthcheck and CRUD API implementations with OpenAPI specifications.
- The usage of [Goose](https://github.com/pressly/goose) for the database migrations and [GORM](https://gorm.io/) as the database ORM.
- The usage of [Zerolog](https://github.com/rs/zerolog) as the centralized Syslog logger.
- The usage of [Validator.v10](https://github.com/go-playground/validator) as the form validator.
- The usage of GitHub actions to run tests and linters, generate OpenAPI specifications, and build and push production images to the Docker registry.
## 🚀 Endpoints
| Name | HTTP Method | Route |
|-------------|-------------|----------------|
| Health | GET | /livez |
| | | |
| List Books | GET | /v1/books |
| Create Book | POST | /v1/books |
| Read Book | GET | /v1/books/{id} |
| Update Book | PUT | /v1/books/{id} |
| Delete Book | DELETE | /v1/books/{id} |
💡 [swaggo/swag](https://github.com/swaggo/swag) : `swag init -g cmd/api/main.go -o .swagger -ot yaml`
## 🗄️ Database design
| Column Name | Datatype | Not Null | Primary Key |
|----------------|-----------|----------|-------------|
| id | UUID | ✅ | ✅ |
| title | TEXT | ✅ | |
| author | TEXT | ✅ | |
| published_date | DATE | ✅ | |
| image_url | TEXT | | |
| description | TEXT | | |
| created_at | TIMESTAMP | ✅ | |
| updated_at | TIMESTAMP | ✅ | |
| deleted_at | TIMESTAMP | | |
## 📦 Container image sizes
- DB: 241MB
- API
- Development environment: 655MB
- Production environment: 28MB ; 💡`docker build -f prod.Dockerfile . -t myapp_app`
## 📁 Project structure
```shell
myapp
├── cmd
│ ├── api
│ │ └── main.go
│ └── migrate
│ └── main.go
│
├── api
│ ├── resource
│ │ ├── book
│ │ │ ├── handler.go
│ │ │ ├── model.go
│ │ │ ├── repository.go
│ │ │ └── repository_test.go
│ │ ├── common
│ │ │ └── err
│ │ │ └── err.go
│ │ └── health
│ │ └── handler.go
│ │
│ └── router
│ ├── middleware
│ │ ├── request_id.go
│ │ ├── request_id_test.go
│ │ ├── requestlog
│ │ │ ├── handler.go
│ │ │ └── log_entry.go
│ │ ├── content_type.go
│ │ └── content_type_test.go
│ └── router.go
│
├── migrations
│ └── 00001_create_books_table.sql
│
├── config
│ └── config.go
│
├── util
│ ├── logger
│ │ └── logger.go
│ └── validator
│ └── validator.go
│
├── .env
│
├── go.mod
├── go.sum
│
├── docker-compose.yml
├── Dockerfile
│
├── prod.Dockerfile
└── k8s
├── app-configmap.yaml
├── app-secret.yaml
├── app-deployment.yaml
└── app-service.yaml
```
## 📸 Form validations and logs
