Questions and Answers

---

Description

The idea of this api is receiving questions and answers from the users. However, each question there will be just one response. If the user think that his answer is better than other they can substitute it.

What Do I need to run?

• You can choose one of two-way to run this API. If you are in Operation System that has make command just enter into API root directory and type make compose. This command is going to use a compose-file and will build and run the application with all dependences. In other hand, if you aren't in OS that has make command you can run it using docker-compose file. To do it, enter in API Root directory and type: docker-compose -f docker-compose.yml up
  

• Using this above commands the api will initialize in localhost:3001 by default, but you can change this behavior change docker-compose.yml environment variables.

  In the compose-file and make file there are some environment variables, I explain all of then bellow:

- MONGO_URL: This Variable configure the URL to connect on MongoDB. You need to use something like it, for example: mongodb://localhost:27017
- MONGO_COLLECTION: This Variable configure what is the name of collection that you'd like to put into mongodb. Example: BairesDev
- SERVER_URL: This Variable configure what is the Address and port that the server are going to running. Example: localhost:3000 or :3000 </br> 

---

What I used of develop it:

• I used Golang version 1.15 with Go Modules enabled;
• I used MongoDB version 4.4 in a Docker container;
• I used MacOs Operation System (Catalina version);
• I used the Goland Jetbrains IDE;
• I used Postman to consume this API.
• I used Docker (version 19.03.12)

What are command that have in Makefile

Here I will describe some commands that you can run using Makefile interface

make compose: this command will start all the application using docker-compose way
make compose-rebuild: this command always compile the image first and after that they are going to start the API
make test: to see unit test coverage, **but you have to install go locally.**

---

Documentation

Here, I will describe the some points that I consider important to share.

Endpoint

Describing all 3 endpoint of API:

• GET: <url>/question/: This will bring to us all questions and answers that we have in questions collections. The payload returned by api is:

[
    {
        "id": "5f6c121031d86158915d8b83",
        "question": "What is the best language in the world?",
        "user": "Zuchi, Jederson",
        "createdDate": "0000-12-31T20:53:32-03:06",
        "updatedDate": "2020-09-24T00:29:39.319-03:00",
        "answer": "golang is the best language of the entire world."
    },
    {
        "id": "5f6c1321880b9da8ba7c6063",
        "question": "The rust is a good language",
        "user": "Zuchi, Jederson",
        "createdDate": "2020-09-24T00:31:40.929-03:00",
        "updatedDate": "2020-09-24T00:32:35.621-03:00",
        "answer": "Yes, it's good but go is better"
    }
]

The status code that can be return here are: 200 (StatusOK) or 500 (InternalServerError)

POST: <url>/question/: In this Url we can perform some insert operations. The Json that need to be send is a single json object described bellow:

{
    "question": "The rust is a good language",
    "user": "Zuchi, Jederson",
    "answer": "Yes, it's good but go is better"
}

The only attribute that is required in Json is the question attribute. The others attributes are optional.
The Status code that can be return here are: 201 (Created), 400 (BadRequest) or 500 (InternalServerError)

PUT: <url>question/<id>: In this Url we can perform some update operations. The Json that need to be sent is a single json object described bellow:

{
    "question": "The rust is a good language",
    "user": "Zuchi, Jederson",
    "createdDate": "2020-09-24T00:29:39.319-03:00"
    "answer": "Yes, it's good but go is better"
}

The only attribute that is required in Json is the question attribute. However, I recommend you that you send all Attributes describe above, the only exception is the answer attribute that we can send or not. The Status code that can be return here are: 204 (NoContent), 400 (BadRequest) or 500 (InternalServerError)

Database Collection

In the database collection I Have just one collection called question stored on mongoDb

Future works, If I will:

• In put endpoint I could make other struct to improve the attributes validation.
• In mongodb repository I will need make some improvement in Unit test.
• I'd like to execute some integration test also some end-to-end test
• In the docker-compose file, I need to put healthcheck conditions to see if the container stay running
• I can use an API-Key. However, just to demonstrate proposed, I thought that is not important in this moment.
• Last but not least, I'd like to make a front end using VueJs in version 3.0