Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naeemaei/golang-clean-web-api
Golang Clean architecture REST API example with a comprehensive real project. It uses docker, docker compose, redis, elasticsearch, kibana, filebeat, postgresql, prometheus, grafana. also use gin, gorm, viper, zerolog, zap, validator, dynamic search, swagger and JWT
https://github.com/naeemaei/golang-clean-web-api
clean-architecture docker docker-compose elasticsearch example-project filebeat gin go go-api go-rest-api golang golang-api golang-examples kibana postgresql redis rest-api swagger webapi
Last synced: 7 days ago
JSON representation
Golang Clean architecture REST API example with a comprehensive real project. It uses docker, docker compose, redis, elasticsearch, kibana, filebeat, postgresql, prometheus, grafana. also use gin, gorm, viper, zerolog, zap, validator, dynamic search, swagger and JWT
- Host: GitHub
- URL: https://github.com/naeemaei/golang-clean-web-api
- Owner: naeemaei
- License: mit
- Created: 2023-01-13T15:22:34.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-18T19:59:39.000Z (about 1 month ago)
- Last Synced: 2025-01-07T19:11:35.159Z (14 days ago)
- Topics: clean-architecture, docker, docker-compose, elasticsearch, example-project, filebeat, gin, go, go-api, go-rest-api, golang, golang-api, golang-examples, kibana, postgresql, redis, rest-api, swagger, webapi
- Language: Go
- Homepage:
- Size: 18.4 MB
- Stars: 235
- Watchers: 4
- Forks: 44
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Golang Clean Web API (Dockerize) with a full sample project (Car Sale project)
## System Design Diagram
## Database Design Diagram
## Give a Star! :star:
If you like this repo or found it helpful, please give it a star. Thanks!
## Used Tools
1. [Gin as web framework](https://github.com/gin-gonic/gin)
2. [JWT for authentication and authorization](https://github.com/golang-jwt/jwt)
3. [Redis for caching](https://github.com/redis/redis)
4. [Elasticsearch for logging database](https://github.com/elastic/elasticsearch)
5. [Beat for log shipping](https://github.com/elastic/beats)
6. [Kibana as log viewer](https://github.com/elastic/kibana)
7. [Postgresql as main database engine](https://github.com/postgres/postgres)
8. [PgAdmin as database management tool](https://github.com/pgadmin-org/pgadmin4)
9. [Prometheus for metric database](https://github.com/prometheus/prometheus)
10. [Grafana for metric dashboards](https://github.com/grafana/grafana)
11. [Validator for endpoint input Validation](https://github.com/go-playground/validator)
12. [Viper for configurations](https://github.com/spf13/viper)
13. [Zap for logging](https://github.com/uber-go/zap)
14. [Zerolog for logging](https://github.com/rs/zerolog)
15. [Gorm as ORM](https://github.com/go-gorm/gorm)
16. [Swagger for documentation](https://github.com/swaggo/swag)
17. Docker compose to run project with all dependencies in docker
## How to run
### Run on local system
#### Start dependencies on docker
```bash
docker compose -f "docker/docker-compose.yml" up -d setup elasticsearch kibana filebeat postgres pgadmin redis prometheus node-exporter alertmanager grafana
```
#### Install swagger and run app
```bash
cd src
go install github.com/swaggo/swag/cmd/swag@latest
cd src/cmd
go run main.go
```
##### Address: [http://localhost:5005](http://localhost:5005)
#### Stop
```bash
docker compose -f "docker/docker-compose.yml" down
```
#### Examples
##### Login
```bash
curl -X 'POST' \
'http://localhost:5005/api/v1/users/login-by-username' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"password": "12345678",
"username": "admin"
}'
```
##### Sample filters request body
###### City filter and sort
```json
{
"filter": {
"Name": {
"filterType": "text",
"from": "t",
"type": "contains"
}
},
"pageNumber": 1,
"pageSize": 10,
"sort": [
{
"colId": "name",
"sort": "desc"
}
]
}
```
###### City in range filter
```json
{
"filter": {
"Id": { // Column name
"filterType": "number", // number, text,...
"from": "1",
"to": "7",
"type": "inRange" // contains, equals,...
}
},
"pageNumber": 1,
"pageSize": 10,
"sort": [
{
"colId": "name",
"sort": "desc"
}
]
}
```
### Run project with dependencies on Docker
```bash
docker compose -f "docker/docker-compose.yml" up -d --build
```
#### Web API Run in docker [http://localhost:9001](http://localhost:9001)
```
Token Url: http://localhost:9001/api/v1/users/login-by-username
Username: admin
Password: 12345678
```
#### Kibana [http://localhost:5601](http://localhost:5601)
```
Username: elastic
Password: @aA123456
```
#### Prometheus [http://localhost:9090](http://localhost:9090)
#### Grafana [http://localhost:3000](http://localhost:3000)
```
Username: admin
Password: foobar
```
#### PgAdmin [http://localhost:8090](http://localhost:8090)
```
Username: [email protected]
Password: 123456
```
Postgres Server info:
```
Host: postgres_container
Port: 5432
Username: postgres
Password: admin
```
### Docker Stop
```bash
docker compose -f 'docker/docker-compose.yml' --project-name 'docker' down
```
### Linux
0. build Project and copy configuration
```bash
/src > go build -o ../prod/server ./cmd/main.go
/src > mkdir ../prod/config/ && cp config/config-production.yml ../prod/config/config-production.yml
```
1. Create systemd unit
```bash
sudo vi /lib/systemd/system/go-api.service
```
2. Service config
```
[Unit]
Description=go-api
[Service]
Type=simple
Restart=always
RestartSec=20s
ExecStart=/home/hamed/github/golang-clean-web-api/prod/server
Environment="APP_ENV=production"
WorkingDirectory=/home/hamed/github/golang-clean-web-api/prod
[Install]
WantedBy=multi-user.target
```
3. Start service
```bash
sudo systemctl start go-api
```
4. Stop service
```bash
sudo systemctl stop go-api
```
5. Show service logs
```bash
sudo journalctl -u go-api -e
```
## Project preview
## Swagger
## Grafana
## Kibana
