golang-mongodb-rest

README

GoLang + MongoDB RESTFul

This project is a 'Boilerplate' or 'Starter' to build RESTful Applications and microservices using GoLang (Gin HTTP web framework), MongoDB.

Table of Contents

• Features
• Prerequisites
• Getting Started
• Project Structure
• Future Work

Features

• Gin
• JWT Authentication
• DotEnv with Viper
• Request Validation with Ozzo Validation
• MongoDB ODM (mgm)
• Docker support
• Swagger with gin-swagger

Prerequisites

• Git
• Docker
• Go 1.20 and above

If you are not using Docker, you should also have:

• MongoDB

Getting Started

Repository Clone

# Clone Project
git clone https://github.com/janrockdev/golang-mongodb-rest.git go-rest

# Change Directory
cd go-rest

Using Docker

# Build & Create Docker Containers
docker-compose up -d

Using Local Environment

# Copy Example Env file
cp ./env.example .env

# Change MongoDB URI and Database Name

# MONGO_URI=<mongo_uri>
# MONGO_DATABASE=<db_name>

# Download Modules
go mod download

# Build Project
go build -o go-starter .

# Run the Project
./go-starter

The application starts at port 8080:

• GET /v1/ping Health check endpoint, returns 'pong' message

---

• POST /v1/auth/register Creates a user and tokens
• POST /v1/auth/refresh Refresh expired tokens
• POST /v1/auth/login Login a user

---

• POST /v1/notes Create a new note
• GET /v1/notes Get paginated list of notes
• GET /v1/notes/:id Get a one note details
• PUT /v1/notes/:id Update a note
• DELETE /v1/notes/:id Delete a note

---

• GET /swagger/* Auto created swagger endpoint

You can also see: http://localhost:8080/swagger/index.html

If you want to add new routes and swagger docs, you should run swag init See: Gin Swagger

Project Structure

├── controllers         # contains api functions and main business logic
├── docs                # swagger files 
├── logs
├── middlewares         # request/response middlewares
│   └── validators      # data/request validators
├── models              
│   └── db              # collection models
├── routes              # router initialization
└── services            # general service & database actions

Future Work

• Rate Limiting
• Testing

License

MIT License - Jan Rock