Go API template

This is a template for a Go API project. It includes the following features:

• Clean Architecture
• Swagger Documentation
• Dockerized
• Makefile for easy setup
• API Security
• API Logging
• API Testing

Requirements

• Git - Git CLI
• Code Editor - Basic code editor
• Golang - Golang
• Docker - For containerization and local environment (if you're not using Makefile)
• GoSec & Golang-Lint - Go Validators
• GoFumpt - Stricter GoFMT
• Redoc-CLI - For generating API Documentation (npm install -g @redocly/cli)

Getting started

Native

Download all necessary modules and run the application

go mod download
make run

Docker

First application start

make docker

After the first start

After first setup you can use docker-compose to start and stop / restart the application

docker-compose up
docker-compose down

Swagger

Swagger documentation is available at http://localhost:8080/docs

To generate the Swagger documentation, you can run the following command:

make swagger

Contributing

You can find the detailed contributing guidelines by navigating to the CONTRIBUTE.md file in the repository.

Docs

• Swagger - Swagger Documentation, available after running the application