/credibooktest

Primary LanguageGo

CredibookTest

This simple web service is created for the completion of Credibook Technical Assesment.

Databases

All datas in this web service saved in:

  • MySQL; used as the main database in this service

APIs

Login

This endpoint used for user login

Endpoint
[POST] /login
Request body
{
	"username": "admin",
	"password": "admin"
}

User

Get User

This endpoint used for getting all user list. This API can only be accessed by Admin

Endpoint
[GET] /users
Auth

User auth for this endpoint is bearer token using token got from the login API

Response Success
{
  "total_records": 3,
  "data": [
    {
      "id": 1,
      "created_at": "2021-06-11T15:49:19Z",
      "updated_at": "2021-06-11T15:49:19Z",
      "deleted_at": null,
      "username": "admin",
      "is_admin": true
    }
  ],
  "current_page": 1,
  "total_pages": 1
}

Create New User

This endpoint used for creating new user

Endpoint
[GET] /user
Request body
{
	"username": "User",
	"password": "My Pass"
}
Response Success
{
  "New user created"
}

Transaction

API Get All Transaction

This endpoint used to get all transactions saved in the database.

Endpoint
[GET] /transaction
Auth

User auth for this endpoint is bearer token using token got from the login API

Filters

This API provided 3 filters in the query param :

  • page
  • perpage
  • type; will show transaction with types as in the filter
  • min_amount; will show transaction in with amount higher than or equal as in the filter
  • max_amount; will show transaction in with amount lower than or equal as in the filter
  • order_by; can be used to sort the data, please add ' DESC' if it's sorted descending
Response success
{
  "total_records": 3,
  "data": [
    {
      "id": 1,
      "created_at": "2021-06-14T15:21:42Z",
      "updated_at": "2021-06-14T15:21:42Z",
      "deleted_at": null,
      "user_id": 2,
      "amount": 100000,
      "notes": "Kulakan",
      "type": "expense"
    },
    {
      "id": 2,
      "created_at": "2021-06-14T15:22:17Z",
      "updated_at": "2021-06-14T15:22:17Z",
      "deleted_at": null,
      "user_id": 3,
      "amount": 100000,
      "notes": "Hasil penjualan",
      "type": "income"
    }
  ],
  "current_page": 1,
  "total_pages": 1
}

API Add New Transaction

This endpoint used to create new transaction and save it to the database.

Endpoint
[POST] /transaction
Auth

User auth for this endpoint is bearer token using token got from the login API

Request body
{
	"amount": 10000, //required
	"notes": "Groceries",
	"type": "expense"
}
Response success
{
  "id": 4,
  "created_at": "2021-06-14T23:18:14.65788+07:00",
  "updated_at": "2021-06-14T23:18:14.65788+07:00",
  "deleted_at": null,
  "user_id": 2,
  "amount": 10000,
  "notes": "Groceries",
  "type": "expense"
}

API Update Transaction

This endpoint used to update existing transaction and save it to the database.

Endpoint
[PUT] /transaction/:id
Auth

User auth for this endpoint is bearer token using token got from the login API

Request body
{
	"amount": 150000, //required
	"notes": "Kulakan",
	"type": "Expense"
}
Response success
{
  "id": 4,
  "created_at": "2021-06-14T23:18:14.65788+07:00",
  "updated_at": "2021-06-14T23:18:14.65788+07:00",
  "deleted_at": null,
  "user_id": 2,
  "amount": 150000,
  "notes": "Kulakan",
  "type": "expense"
}

API Delete Transaction

This endpoint used to delete transaction and save it to the database.

Endpoint
[DELETE] /transaction/:id
Auth

User auth for this endpoint is bearer token using token got from the login API

Response success
"transaction has deleted successfully"

Testing

In this service, there's testing provided. To do the testing, you can use command below:

go test ./... -coverprofile=coverage.out