blog360space/sp_friendmanagementapi_golang_sangnguyen

The Friend Management RESTFul Api

Table of Contents

• Introduction
  • Features
  • Quick Installation
  • Quick Start
• Unit Testing
  • Prerequisite
  • How to run

Introduction

A simple api built using Golang 1.4.x

Features

• Golang 1.4.x
• Docker
• MySQL
• Unit Testing

Quick Installation

# Docker Desktop for Mac
https://download.docker.com/mac/stable/Docker.dmg

# Docker Desktop for Windows
https://download.docker.com/win/stable/Docker%20Desktop%20Installer.exe

# Verify it
docker version

Quick Start

# Build the project
docker-compose build

# Launch the project
docker-compose up

# RESTFul Api
http://localhost:8080/api

# Verify it
http://localhost:8080/ping

# Swagger
http://localhost:8080/swagger/index.html

Unit Testing

Prerequisite

# Launch MySQL
docker-compose -f docker-compose.testing.yml up

How to run

Run them directly from GoLand.

Or from the terminal, in the solution root, simply run:

# Go to Friend Commands folder
cd backend/src/commands/friend

# Run all tests
go test

# Run all tests with coverage
go test -cover