Echo REST API MongoDB

This project is an expansion from the Echo rest base repository, also done by me!

The objective here is to expand the basis set by that project but to add a database access layer for MongoDB

I do plan on implementing a version of it that uses Postgres also, but in the future

Any changes to the base project made in this one that are beneficial to the base project will be extracted and ported there

Important: This is a warning message.

This code is not made with the intention of being safe and should not be used in a serious application as is, reason why all the mentions to passwords use the "BadExample" text.

This is a learning project, by the end of it I want to have a fully functional and safe API that could be used as an example of how to do things in golang without having to search too much for it and also as a repository of my knowledge of how to do things in golang.

Features

• MVC pattern for project structure
• Routing with multiple files and folders
• JSON format for data interchange
• Documentation using Swagger 2.0
• Unit testing
• Github actions for CI
  • Running tests
  • Testing build

Libs used

• Echo
  • Backend framework
• Godotenv
  • Environment variables loading
• Swaggo
  • Documentation
• Echo Swagger
  • Serving the Swagger UI
• Testify
  • Unit testing

How to run

To run this API simply use:

go run .

Or alternatively for active development, install Air and then use:

air

Docs

This API project has documentation using Swagger 2.0 and the lib Swaggo with comment annotation, the user controller has examples of how to use them for the for main HTTP request verbs that you'll need.

The latest version of the documentation will always bbe already computed. To access the documentation, run the project then open this link in your browser http://localhost:3000/swagger/index.html

Do note that 3000 is the standard IP address if you haven't changed it through .env

To update the documentation, install the swag CLI and run the command:

swag i

Environment

This api uses a .env file for configuration, at the current moment here are the features that can be configured

• PORT
  • Number representing the port on which the API will be served
• DEBUG
  • If se to true, Debug mode enables the generation of a routes file and the serving of Swagger documentation

Testing

Testing this API was done with mock tests and the Testify lib for assertions alongside Golang's standard testing library

The tests require a .env file inside the test folder and that inlcudes a MongoDB connection string to work properly, later I do plan on making the code launch a mongodb instance during the test setup process

To run all tests, run the following command:

go test ./... 

You can also add the -cover flag at the end to see test coverage in all the packages

Methods

GET

• :id based endpoint to GET single objects
• list endpoint to GET a list of objects with query filters and paging

PUT

• :id based endpoint to UPDATE an object with given param

POST

• JSON body request treatment and response

DELETE

• :id based endpoint to DELETE an object with given id

Writing

One particular design choice I made for this project is to make the names of my variables and functions be more verbose and self descriptive then what I usually see in golang projects

I much prefer to work with code like this:

func DeleteUser(echo echo.Context) error {
	var id string
	id = echo.Param("id")

	response := model.DeleteUserResponse{
		ID: id,
	}

	return echo.JSON(http.StatusOK, response)
}

Then this:

func DeleteUser(e echo.Context) error {
	var id string
	id = e.Param("id")

	r := model.DeleteUserResponse{
		ID: id,
	}

	return e.JSON(http.StatusOK, r)
}