makupi/backend-homework

https://github.com/togglhire/backend-homework

Hi there 👋

backend-homework's Issues

Add Logging Middleware

API Table design for Questions

Probably two tables, questions and options

questions

id: pkey, int	body: text

options

id: pkey, int	body: text	correct: bool	question_id: fkey(questions.id), int

GET /questions returns null if no questions are found

Use GraphQL instead of REST to implement the API

Use GraphQL instead of REST to implement the API

Define a schema for the API that covers the basic requirements and implement all queries and resolvers. You do not need to implement the REST API if you choose to do this.

Pagination for GET /questions

Pagination for the list endpoint

This can be in the form of basic offset pagination, or seek pagination. The difference is explained in this post.

Improve REST API error messages

JWT authentication mechanism

Clients are required to send a JSON Web Token that identifies the user in some way. The API returns only questions that belong to the authenticated user. Endpoint for generating tokens is not needed, we can generate them through jwt.io

Use PORT environment variable for http server, default to 3000

The PORT environment variable is used as the port number for the server, defaulting to 3000

DELETE /questions/{id} to delete an existing question

Endpoint that allows to delete existing questions

Storage interface for sqlite

Create an interface for the storage and an sqlite implementation

PUT /questions/{id} to update an existing question

The third endpoint updates an existing question and returns the updated question in the response. The whole question is included in the request body, including all attributes. The question to be updated should be identified in the request URL. The order of options in the request body should be stored the same way as explained in the create endpoint above.

For example, to change the question from before to ask about sunrise, we would send the following JSON.

{
  "body": "Where does the sun rise?",
  "options": [
    {
      "body": "East",
      "correct": true
    },
    {
      "body": "West",
      "correct": false
    }
  ]
}

DELETE /questions/{id}/option/{id} to delete an option

PUT /questions/{id}/option/{id} to update an option

GET /questions to retrieve all questions

The first endpoint should return a list of all questions in the database. The order of questions and options inside questions should be stable, i.e. not change on every request. The whole question, including the options is returned.

For example, the response could look like this:

[
  {
    "body": "Where does the sun set?",
    "options": [
      {
        "body": "East",
        "correct": false
      },
      // other options...
    ]
  },
  {
    "body": "What is the answer to the ultimate question of life, the universe, and everything?",
    // rest of the question...
  },
  {
    "body": "But what is the ultimate question?",
    // rest of the question...
  }
]

POST /questions to create a new question

The second endpoint creates a new question in the database and then returns it in the response. The request body contains the question in JSON. The order of options in the request body should be stored as well and the same order should be returned by the API from all requests.

For example, for the request containing the following JSON, the server would return the question show above, in the Questions section.

{
  "body": "Where does the sun set?",
  "options": [
    {
      "body": "East",
      "correct": false
    },
    {
      "body": "West",
      "correct": true
    }
  ]
}

POST /questions/{id}/option to add a new option to a question