REST API microservice in Go

Why this ?

Offered Features

API Features:

1. OWASP Compliant Open API 3 Specification: Refer to OpenApi-v1.yaml for details.
2. Middleware for:
   • Logging: Facilitates debugging and monitoring processes.
   • Authentication: Provides a placeholder for diverse authentication mechanisms.
   • Tracing by Request ID: Assists in debugging procedures.
   • Panic Recovery: Ensures service continuity by managing unexpected errors.
   • Common Security Headers: Safeguards the service against potential vulnerabilities.
   • Query Parameters Validation: Enhances service security by validating query parameters.
3. Standardized Error Handling: All errors are managed and returned in a uniform format.
4. Versioning
5. Model Management:
   • Internally used data models differ from those exposed to clients, ensuring separation and security.

Go Application Features:

1. Configuration Management: via Environment Variables
2. Dockerized Environment: Facilitates service deployment.
3. Makefile: Automates common tasks for developers.
4. Git Action: Automates build processes, runs tests, and generates code coverage.
5. Integrated Go Formatter and Linter: Promotes code quality and consistency.
6. Secrets Loading Mechanism from Sidecar
7. Support for Multiple Databases: Enables connections to various database systems.
8. Best Practices for MongoDB Connection
9. Effective Mocking Practices for Unit Test Patterns
10. Seed Data: for Local Development
11. Standardized Filename Conventions: Enhances code readability.
12. Multi-Stage Docker Build: Accelerates build processes.
13. Versioning Utilizing Git Commit History

Folder Structure

go-rest-api-example/
├── main.go
├── internal/
│   ├── db
│   ├── errors
│   ├── handlers
│   ├── logger
│   ├── middleware
│   ├── models
│   ├── server
│   ├── util
│   └── mockData
├── localDevelopment/
├── Makefile
├── Dockerfile
├── OpenApi-vi.yaml
├── docker-compose.yaml
└── OpenApi-v1.postman_collection.json

QuickStart

Pre-requisites

• Docker
• Docker Compose
• Make
• golangci-lint

Frequently used commands

  start                          Start all necessary services and API server
  run                            Run the API server
  setup                          Start only dependencies
  test                           Run tests with coverage

Development commands

  lint                           Run the linter
  lint-fix                       Run the linter and fix issues
  clean                          Clean all Docker resources
  coverage                       Generate and display the code coverage report
  go-work                        Generate Go work file
  owasp-report                   Generate OWASP report
  tidy                           Tidy Go modules

CI commands

  build                          Build the API server binary
  ci-coverage                    Check if test coverage meets the threshold
  format                         Format Go code
  version                        Display the current version of the API server

Docker commands

  docker-build                   Build the Docker image
  docker-build-debug             Build the Docker image without cache
  docker-clean                   Clean all Docker resources
  docker-clean-build-images      Remove build images
  docker-remove                  Remove Docker images and containers
  docker-run                     Run the Docker container
  docker-start                   Build and run the Docker container
  docker-stop                    Stop the Docker container

Tools

1. Routing - Gin
2. Logging - zerolog
3. Database - MongoDB
4. Container - Docker

TODO

• Add more and clear documentation about the features this offers and how to replace tools
• Add DB Migration Support
• Add more environmental profiles and obey all 12-Factor App rules
• Implement all OWASP security checks specified in the API Spec
• Improve error codes and messages
• Add git hooks for pre-commit and pre-push

Good to have

• Improve data model and add more fields
• Deploy to cloud
• Implement Update Operations mentioned in the API Spec

References

• gin-boilerplate
• go-rest-api
• go-base

Contribute

• Please feel free to Open PRs
• Please create issues with any problem you noticed
• Please suggest any improvements

Why this ?

I embarked on the endeavor of crafting my own open-source boilerplate repository for several reasons:

After years of developing Full Stack applications utilizing ReactJS and JVM-based languages, I observed that existing boilerplate's tended to be either excessive or insufficient for my needs. Consequently, I resolved to construct my own, while adhering rigorously to the principles and guidelines of Go. While similarities with popular Go boilerplate templates may be evident, I have customized this repository to better align with my preferences and accumulated experiences. (My apologies if I inadvertently overlooked crediting any existing templates.)

I yearned for the autonomy to meticulously select the tools for fundamental functionalities such as Routing, Logging, and Configuration Management, ensuring seamless alignment with my personal preferences and specific requirements.

What this is not ?

• This isn't a complete solution for all your needs. It's more like a basic template to kickstart your project.
• This isn't the best place to begin if you want to make an online store. What I've provided is just a simple tool for managing data through an API.