gbrayhan / microservices-go Goto Github PK

Golang Microservice Boilerplate using MySQL, Docker and Swagger, API REST. Gin Go and GORM with pagination and implementation of a Clean Architecture.

License: MIT License

Go 99.63% Dockerfile 0.37%

microservices-architecture golang-examples boilerplate boilerplate-go boilerplate-microservice rest-api gin go boilerplate-golang gorm

microservices-go's Introduction

Golang Microservices Boilerplate - Clean Architecture

Example structure to start a microservices project with golang. Using a MySQL databaseSQL. Using a Hexagonal Architecture tha is a Clean Architecture.

Manual Installation

If you would still prefer to do the installation manually, follow these steps:

Clone the repo:

git clone https://github.com/gbrayhan/microservices-go

If you need, configure the environment variables in file config.json, if you use docker-compose leave the variables set in the file config.json.example

cp config.json.example config.json

TL;DR command list

git clone https://github.com/gbrayhan/microservices-go
cd microservices-go
cp config.json.example config.json
docker-compose up  --build  -d

Features
Commands
Environment Variables
Project Structure
API Documentation
Error Handling
Validation
Linting

Features

Golang v1.21: Stable version of go
Framework: A stable version of gin-go
Token Security: with JWT
SQL databaseSQL: MariaDB using internal sql package of go sql
Testing: unit and integration tests using package of go testing
API documentation: with swaggo @latest version that is a go implementation of swagger
Dependency management: with go modules
Environment variables: using viper
Docker support
Code quality: with CodeFactor and Codacy
Linting: with golangci-lint an implementation of a Golang linter

Commands

Build and run image of docker

docker-compose up  --build  -d

Swagger Implementation

swag init -g src/infrastructure/rest/routes/routes.go

To visualize the swagger documentation on local use

http://localhost:8080/v1/swagger/index.html

To see the postman collection use

https://www.postman.com/kts-mexico/workspace/boilerplategomicroservice

Unit test command

# run recursive test
go test  ./test/unit/...
# clean go test results in cache
go clean -testcache

Lint inspection of go

golangci-lint run ./...

microservices-go's People

Contributors

Stargazers

Watchers

Forkers

m01k0 emiretamar otakudang24 locopump garlen-javier kidmam whary11 dokshor alfredosotil aicelerity-py prem0132 phamtuanchip mohammadraasel lexuanquynh guanchengliu17 my-cloud-native fedor-malyshkin vizer0-0b gkranasinghe ankitcharles nuttchai anthanh17 ericbae2011 yuri-kanagawa ericbae1975 culy247 jenny-hag loanvuopn vbanurag asyasyarif claygod afiflampard tawseefnabi hi-ernest phanithken supershells ezizull yourbrainrun tuanama13 nautiam stephencherry hungngomobile yuttasakcom rubemlrm tuvuanh27 donquixxy varenty02 govilkargaurav chrisloarryn sudarsan-sridharan kumailnaqvi354 anhgeeky dynx32 ht-ph4m tuandat732 rezky08 chrisfrontdev jmvoid adon988

microservices-go's Issues

POST /user returns `Invalid Token` error

I've just started to mess around with this template and I'm not fully experienced with how Golang works quite yet but I'm having trouble getting the /user endpoint to successfully create a new user due to a missing/invalid token within the authorization header. I'm not sure what the value could be or where it's located in the project (I assume it's in config.json) so I appreciate any help that I can get.

Response with a random value:

{
    "error": "Invalid token"
}

Response with no value:

{
    "error": "Token not provided"
}

relevant Secure config values (all default values):

{
    "Secure": {
	"JWTAccessSecure": "accesskeyyoumayneedtochangeit",
	"JWTRefreshSecure": "refreshkeyyoumayneedtochangeit",
	"JWTAccessTimeMinute": 10,
	"JWTRefreshTimeHour": 10
    },
}

Can you make the tutorials for build this repository?

thanks for sharing your repo source code. if so can you share how to build your app?

Fix code scanning alert - Database query built from user-controlled sources

Tracking issue for:

https://github.com/gbrayhan/microservices-go/security/code-scanning/1

Fix code scanning alert - Incorrect conversion between integer types

Tracking issue for:

https://github.com/gbrayhan/microservices-go/security/code-scanning/2

Incorrect docs.go after swag init

Describe the bug
Whenever I do swag init -g routes/ApplicationV1.go the resulting docs.go is incorrect and doesn't look like the previous one.

To Reproduce
Steps to reproduce the behavior:

run swag init -g routes/ApplicationV1.go
verify docs.go
missing structs and most of the one that is there swag.Spec is unresolved.

Expected behavior
The docs.go should update correctly

Screenshots

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
I just started using the Template and have ran go get to download all the mods. I have also installed swag/cmd but I am unaware of the correct version to use.