/challenge-verifymy

Primary LanguageGo

Challenge-VerifyMy

Candidate: Vinicius Cardozo

LinkedIn: Vinicius Cardozo LinkedIn

Requirements

Setup

After cloning the repository, to run the project, execute the following command:

make up

By default, the API runs on localhost and port 8082, and the database on port 27017. However, these variables can be changed in the .env file.

User Routes

Create

Method: POST

/api/v1/user/

Example

In the terminal, execute:

curl -XPOST -H "Content-type: application/json" \
-d '{
  "name": "Vinicius",
  "age": 27,
  "email": "vinicius@email.com",
  "password": "1234",
  "address": "street 01"
}' 'http://localhost:8082/api/v1/user/'

Or, in any other interface of your choice, such as Postman or Insomnia.

Body (application/json):

{
  "name": "Vinicius",
  "age": 27,
  "email": "vinicius@email.com",
  "password": "1234",
  "address": "street 01"
}

Expected Output

HTTP Status: 201 Created

{   
    "status": "success",
    "data": {
        "user": {
            "id": "656d2023f9f106023340ebeb",
            "name": "Vinicius",
            "age": 27,
            "email": "vinicius@email.com",
            "password": "1234",
            "address": "street 01"
        }
    }
}

Read

Method: GET

/api/v1/user/:id

Parameters:

  • ID: User ID

Example

In the terminal, execute:

curl -XGET 'http://localhost:8082/api/v1/user/:id'

Or, in any other interface of your choice, such as Postman or Insomnia.

Expected Output

HTTP Status: 200 OK

{   
    "status": "success",
    "data": {
        "user": {
            "id": "656d2023f9f106023340ebeb",
            "name": "Vinicius",
            "age": 27,
            "email": "vinicius@email.com",
            "password": "1234",
            "address": "street 01"
        }
    }
}

ReadAll

Method: GET

/api/v1/user/

Example

In the terminal, execute:

curl -XGET 'http://localhost:8082/api/v1/user/'

Or, in any other interface of your choice, such as Postman or Insomnia.

Expected Output

HTTP Status: 200 OK

{   
    "status": "success",
    "users": [
        {
          "id": "656d2023f9f106023340ebeb",
          "name": "Vinicius",
          "age": 27,
          "email": "vinicius@email.com",
          "password": "1234",
          "address": "street 01"
        }
    ]
}

Update

Method: PUT

/api/v1/user/:id

Parameters:

  • ID: User ID

Example

In the terminal, execute:

curl -XPUT -H "Content-type: application/json" \
-d '{
  "name": "Vinicius",
  "age": 27,
  "email": "vinicius@email.com",
  "password": "1234",
  "address": "street 01"
}' 'http://localhost:8082/api/v1/user/:id'

Or, in any other interface of your choice, such as Postman or Insomnia.

Body (application/json):

{
  "name": "Vinicius",
  "age": 27,
  "email": "vinicius@email.com",
  "password": "1234",
  "address": "street 01"
}

Expected Output

HTTP Status: 201 Created

{   
    "status": "success",
    "data": {
        "user": {
            "id": "656d2023f9f106023340ebeb",
            "name": "Vinicius",
            "age": 27,
            "email": "vinicius@email.com",
            "password": "1234",
            "address": "street 01"
        }
    }
}

Delete

Method: DELETE

/v1/:id

Parameters:

  • ID: User ID

Example

In the terminal, execute:

curl -XDELETE 'http://localhost:8082/api/v1/user/:id'

Or, in any other interface of your choice, such as Postman or Insomnia.

Expected Output

HTTP Status: 204 OK

Run Tests

Requirements

  • Golang 1:20

To run the tests:

make test

The expected output will be:

go test -race challenge-verifymy/app/api challenge-verifymy/app/handlers challenge-verifymy/cmd challenge-verifymy/common challenge-verifymy/config challenge-verifymy/core/models challenge-verifymy/core/ports challenge-verifymy/core/ports/testutil challenge-verifymy/core/services challenge-verifymy/customerror challenge-verifymy/infrastructure/mongodb -coverprofile=coverage.out
?       challenge-verifymy/app/api      [no test files]
?       challenge-verifymy/cmd  [no test files]
?       challenge-verifymy/common       [no test files]
?       challenge-verifymy/config       [no test files]
?       challenge-verifymy/core/ports   [no test files]
?       challenge-verifymy/core/ports/testutil  [no test files]
ok      challenge-verifymy/app/handlers 0.092s  coverage: 78.8% of statements
ok      challenge-verifymy/core/models  0.058s  coverage: 50.0% of statements
?       challenge-verifymy/customerror  [no test files]
?       challenge-verifymy/infrastructure/mongodb       [no test files]
ok      challenge-verifymy/core/services        0.055s  coverage: 100.0% of statements