go-rest-api-boilerplate

A REST API Boilerplate written in Go.

Author(s): John Connor Sanders
Current Version: 0.0.1
Release Date: 9/25/2022
MIT License

Getting Started

Follow the instructions below to get the Go REST API up and running on your local environment

Prerequisites

MongoDB 4+
Go 1.18+

Setup

Create a conf.json file from the example file and configure the following settings:

MongoDB URI Connection String
Secret Encryption String
Mongo Database Name
Master Admin Username
Master Admin Email
Master Admin Initial Password
Whether to run App with HTTPS
If HTTPS is on, the cert.pem file
If HTTPS is on, the path to the key.pem file
Whether you want new users to be able to sign themselves up for accounts
Run ENV

Use the provided install.sh script to build a background service

$ cp conf.json.example conf.json
$ vi conf.json

Running the API

Production

One way to set up and start a production build is to run the following:

Build executable and install the SystemD service:

$ go build github.com/JECSand/go-rest-api-boilerplate
$ sh ./scripts/setup_service.sh

To start the API:

$ sh ./scripts/start.sh

To stop the API:

$ sh ./scripts/stop.sh

Development

To start the API in development:

$ go run github.com/JECSand/go-rest-api-boilerplate

To stop the development API, enter 'ctrl + c'

Testing

Integration Test

$ go test github.com/JECSand/go-rest-api-boilerplate/cmd

Unit Tests

Test Auth Module:

$ go test github.com/JECSand/go-rest-api-boilerplate/auth

Test Database Module:

$ go test github.com/JECSand/go-rest-api-boilerplate/database

Test Models Module:

$ go test github.com/JECSand/go-rest-api-boilerplate/models

API Route Guide

I) Authentication Routes

1. Signin

POST - /auth

Request

Headers

{
  Content-Type: application/json
}

Body

{
  "email": "email@example.com",
  "password": "userpass"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Auth-Token: "",
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH
}

Body

{
  "id": "000000000000000000000011",
  "username": "userName",
  "firstname": "john",
  "lastname": "smith",
  "email": "user@example.com",
  "role": "member",
  "group_id": 000000000000000000000001",
  "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
  "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
}

2. Signup

POST - /auth/register
This route will return a 404 if the "Registration" setting is set to "off" in the conf.json file.

Request

Headers

{
  Content-Type: application/json
}

Body

{
  "firstname": "john",
  "lastname": "smith",
  "email": "user@example.com",
  "password": "789xyz",
  "username": "userName",
  "password": "userpass"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Auth-Token: "",
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "id": "000000000000000000000012",
  "username": "userName",
  "firstname": "john",
  "lastname": "smith",
  "email": "user@example.com",
  "role": "member",
  "groupuuid": "000000000000000000000002",
  "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
  "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
}

3. Refresh Token

GET - /auth

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Auth-Token: "",
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

4. Signout

DELETE - /auth

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH
}

5. API Key - Expires after 6 Months

GET - /auth/api-key

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Auth-Token: "",
  API-Key: "",
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

6. Update Password

POST - /auth/password

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Body

{
  "current_password": "current_password",
  "new_password": "new_password"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

II) Task Routes

1. List Tasks

GET - /tasks

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
    "tasks": [
        {
            "id":  "000000000000000000000021",
            "name": "todo_name",
            "due": 2019-08-01 12:04:01 -0000 UTC,
            "status": "NOT_STARTED",
            "description": "Task to complete",
            "user_id": "000000000000000000000011",
            "group_id": "000000000000000000000001",
            "last_modified": 2019-06-07 20:28:09.400248747 +0000 UTC,
            "created_at": 2019-06-07 20:28:09.400248747 +0000 UTC
        }
    ]
}

2. List Task

GET - /tasks/{taskId}
todoId parameter is optional, if used the request will only return an object for that item.

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
    "id":  "000000000000000000000021",
    "name": "todo_name",
    "due": 2019-08-01 12:04:01 -0000 UTC,
    "status": "NOT_STARTED",
    "description": "Task to complete",
    "user_id": "000000000000000000000011",
    "group_id": "000000000000000000000001",
    "last_modified": 2019-06-07 20:28:09.400248747 +0000 UTC,
    "created_at": 2019-06-07 20:28:09.400248747 +0000 UTC
}

3. Create Task

POST - /tasks

Request

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Auth-Token: ""
}

Body

{
    "name": "todo_name",
    "due": 2019-08-01 12:04:01 -0000 UTC,
    "description": "Task to complete"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
   "id":  "000000000000000000000021",
   "name": "todo_name",
   "due": 2019-08-01 12:04:01 -0000 UTC,
   "status": "NOT_STARTED",
   "description": "Task to complete",
   "user_id": "000000000000000000000011",
   "group_id": "000000000000000000000001",
   "last_modified": 2019-06-07 20:28:09.400248747 +0000 UTC,
   "created_at": 2019-06-07 20:28:09.400248747 +0000 UTC
}

4. Modify Task

PATCH - /tasks/{taskId}

Request

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Auth-Token: ""
}

Body

{
    "name": "new_todo_name",
    "due": 2019-08-06 12:04:01 -0000 UTC,
    "description": "Updated Task to complete",
    "status": "COMPLETED",
    "user_id": "000000000000000000000011"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
   "id":  "000000000000000000000022",
   "name": "new_todo_name",
   "due": 2019-08-01 12:04:01 -0000 UTC,
   "status": "COMPLETED",
   "description": "Task to complete",
   "user_id": "000000000000000000000011",
   "group_id": "000000000000000000000001",
   "last_modified": 2019-06-07 20:28:09.400248747 +0000 UTC,
   "created_at": 2019-06-07 20:28:09.400248747 +0000 UTC
}

5. Delete Task

DELETE - /task/{taskId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

III) Users Routes (Admins Only)

1. List Users

GET - /users

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
    "users": [
        {
            "id": "000000000000000000000011",
            "username": "userName",
            "firstname": "jane",
            "lastname": "smith",
            "email": "user@example.com",
            "role": "member",
            "group_id": "000000000000000000000001",
            "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
            "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
        }
    ]
}

2. List User

GET - /users/{userId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
        "id": "000000000000000000000011",
        "username": "userName",
        "firstname": "jane",
        "lastname": "smith",
        "email": "user@example.com",
        "role": "member",
        "group_id": "000000000000000000000001",
        "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
        "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
}

3. Create User

POST - /users

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Body

{
  "username": "userName",
  "firstname": "jane",
  "lastname": "smith",
  "email": "user@example.com",
  "password": "xyz789",
  "role": "member"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "id": "000000000000000000000012",
  "username": "userName",
  "firstname": "jane",
  "lastname": "smith",
  "email": "user@example.com",
  "role": "member",
  "group_id": "000000000000000000000001",
  "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
  "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
}

4. Modify User

PATCH - /users/{userId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Body

{
  "id": "000000000000000000000012",
  "username": "newUserName",
  "firstname": "jane",
  "lastname": "smith",
  "email": "new_test@email.com",
  "password": "newUserpass",
  "role": "member",
  "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
  "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "id": "000000000000000000000012",
  "username": "newUserName",
  "firstname": "jane",
  "lastname": "smith",
  "email": "new_test@email.com",
  "role": "member",
  "group_id": "000000000000000000000001",
  "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
  "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
}

5. Delete User

DELETE - /users/{userId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

6. Get User Tasks

GET - /users/{userId}/tasks

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "user": {
    "id": "000000000000000000000012",
    "username": "newUserName",
    "firstname": "jane",
    "lastname": "smith",
    "email": "new_test@email.com",
    "role": "member",
    "group_id": "000000000000000000000001",
    "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
    "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
  },
  "tasks": [
    {
        "id": "000000000000000000000022",
        "name": "task_name",
        "status": "NOT_STARTED",
        "due": 2019-06-07 20:28:09.400248747 +0000 UTC,
        "description": "Task to complete",
        "user_id": "000000000000000000000012",
        "group_id": "000000000000000000000001",
        "last_modified": 2019-06-07 20:28:09.400248747 +0000 UTC,
        "created_at": 2019-06-07 20:28:09.400248747 +0000 UTC
    }
  ]
}

IV) User Group Routes (Admins Only)

1. List User Groups

GET - /groups

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
    "groups": [
        {
            "id": "000000000000000000000001",
            "name": "groupName",        
            "last_modified": 2019-06-07 20:17:14.358617998 +0000 UTC,
            "creation_datetime": 2019-06-07 20:17:14.358617998 +0000 UTC
        }
    ]
}

2. List User Group

GET - /groups/{groupId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
    "id": "000000000000000000000001",
    "name": "groupName",        
    "last_modified": 2019-06-07 20:17:14.358617998 +0000 UTC,
    "creation_datetime": 2019-06-07 20:17:14.358617998 +0000 UTC
}

3. Create User Group

POST - /groups

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Body

{
  "name": "newGroup"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "id": "000000000000000000000002",
  "name": "newGroup",    
  "last_modified": 2019-06-07 20:18:15.145971952 +0000 UTC,
  "creation_datetime": 2019-06-07 20:18:15.145971952 +0000 UTC
}

4. Modify User Group

PATCH - /groups/{groupId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Body

{
  "Name": "newGroupName"
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "id": "000000000000000000000002",
  "name": "newGroup",    
  "last_modified": 2019-06-07 20:18:15.145971952 +0000 UTC,
  "creation_datetime": 2019-06-07 20:18:15.145971952 +0000 UTC
}

5. Delete User Group

DELETE - /groups/{groupId}

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

6. Get Group Users

GET - /groups/{groupId}/users

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "group": {
    "id": "000000000000000000000002",
    "name": "newGroup",    
    "last_modified": 2019-06-07 20:18:15.145971952 +0000 UTC,
    "creation_datetime": 2019-06-07 20:18:15.145971952 +0000 UTC
  },
  "users": [
    {
      "id": "000000000000000000000011",
      "username": "userName",
      "firstname": "jane",
      "lastname": "smith",
      "email": "user@example.com",
      "role": "member",
      "group_id": "000000000000000000000002",
      "last_modified": 2019-06-07 20:17:14.630917778 +0000 UTC,
      "created_at": 2019-06-07 20:17:14.630917778 +0000 UTC
    }
  ]
}

7. Get Group Tasks

GET - /groups/{groupId}/tasks

Request

Headers

{
  Content-Type: application/json,
  Auth-Token: ""
}

Response

Headers

{
  Content-Type: application/json; charset=UTF-8,
  Date: DoW, DD MMM YYYY HH:mm:SS GMT,
  Content-Length: 0,
  Access-Control-Allow-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Expose-Headers: Content-Type, Auth-Token, API-Key,
  Access-Control-Allow-Origin: *,
  Access-Control-Allow-Methods: GET,DELETE,POST,PATCH  
}

Body

{
  "group": {
    "id": "000000000000000000000002",
    "name": "newGroup",    
    "last_modified": 2019-06-07 20:18:15.145971952 +0000 UTC,
    "creation_datetime": 2019-06-07 20:18:15.145971952 +0000 UTC
  },
  "tasks": [
    {
        "id": "000000000000000000000022",
        "name": "task_name",
        "status": "NOT_STARTED",
        "due": 2019-06-07 20:28:09.400248747 +0000 UTC,
        "description": "Task to complete",
        "user_id": "000000000000000000000001",
        "group_id": "000000000000000000000002",
        "last_modified": 2019-06-07 20:28:09.400248747 +0000 UTC,
        "created_at": 2019-06-07 20:28:09.400248747 +0000 UTC
    }
  ]
}

Name		Name	Last commit message	Last commit date
Latest commit History 19 Commits
auth		auth
cmd		cmd
database		database
models		models
scripts		scripts
server		server
services		services
utilities		utilities
.gitignore		.gitignore
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
conf.json.example		conf.json.example
docker-compose.yml		docker-compose.yml
go.mod		go.mod
go.sum		go.sum
main.go		main.go

License

JECSand/go-rest-api-boilerplate

Folders and files

Latest commit

History

Repository files navigation

go-rest-api-boilerplate

Getting Started

Prerequisites

Setup

Running the API

Production

Development

Testing

API Route Guide

I) Authentication Routes

1. Signin

Request

Response

2. Signup

Request

Response

3. Refresh Token

Request

Response

4. Signout

Request

Response

5. API Key - Expires after 6 Months

Request

Response

6. Update Password

Request

Response

II) Task Routes

1. List Tasks

Request

Response

2. List Task

Request

Response

3. Create Task

Request

Response

4. Modify Task

Request

Response

5. Delete Task

Request

Response

III) Users Routes (Admins Only)

1. List Users

Request

Response

2. List User

Request

Response

3. Create User

Request

Response

4. Modify User

Request

Response

5. Delete User

Request

Response

6. Get User Tasks

Request

Response

IV) User Group Routes (Admins Only)

1. List User Groups

Request

Response

2. List User Group

Request

Response

3. Create User Group

Request

Response

4. Modify User Group

Packages