API de Enquetes

Aplicação consciste em um API de Enquetes. Foi desenvolvida ultilzando um arquitetura bem definida e desacoplada, ultilizando TDD como metotologia de trabalho e Clean Architecture para fazer a distribição das resposabildades em camadas, e sempre que possível ultilizando os principios do SOLID.

Instruções para rodar o projeto

Os requisitos necessários são:

Node
npm
Mongodb

Faça o clone do projeto e rode o comando npm install para instalar as dependências.

npm install

Subir o servidor de desenvolvimento atravéz do comando npm run dev

npm run dev

Configurar as variáveis de ambiente criando um arquivo .env na raiz do projeto, e seguindo o examplo do arquivo .env.example.

Testes

npm test

Documentação

A documentação completa pode ser encontrada no Swagger através do endpoits /api-docs

Principais funcionalidades

Cadastro
Login
Criar enquetes
Listar enquetes
Responder enquetes
Resultado da enquete

Endpoints da aplicação

Rota de Cadastro

[POST] /signup

Request body

{
   "name": "string",
   "email": "string",
   "password": "string",
   "passwordConfirmation": "string"
}

Responses

{
    "accessToken": "string",
    "name": "string"
}

{
    "error": "string"
}

Rota de Login

[POST] /login

Request body

{
  "email": "string",
  "password": "string"
}

Responses

{
    "accessToken": "string",
    "name": "string"
}

{
    "error": "string"
}

Rota de Criar enquetes private

[POST] /surveys

Parameters in header

{
"x-access-token": "string"
}

Request body

{
"question": "string",
  "answers": [
    {
      "image": "string",
      "answer": "string"
    }
  ]
}

Responses

{
    "error": "string"
}

Rota de Listar enquetes private

[GET] /surveys

Parameters in header

{
"x-access-token": "string"
}

Responses

[
  {
    "id": "string",
    "question": "string",
    "answers": [
      {
        "image": "string",
        "answer": "string"
      }
    ],
    "date": "string",
    "didAnswer": boolean
  }
]

{
    "error": "string"
}

Rota para criar resposta de uma enquete private

[PUT] /surveys/{surveyId}/results

Parameters in header

{
"x-access-token": "string"
}

Parameters in route

{
"surveyId": "string"
}

Request body

{
  "answer": "string"
}

Responses

{
  "surveyId": "string",
  "question": "string",
  "answers": [
    {
      "image": "string",
      "answer": "string",
      "count": number,
      "percent": number,
      "isCurrentAccountAnswer": boolean
    }
  ],
  "date": "string"
}

{
    "error": "string"
}

Rota para consultar o resultado de uma enquete private

[GET] /surveys/{surveyId}/results

Parameters in header

{
"x-access-token": "string"
}

Parameters in route

{
"surveyId": "string"
}

Responses

{
  "surveyId": "string",
  "question": "string",
  "answers": [
    {
      "image": "string",
      "answer": "string",
      "count": number,
      "percent": number,
      "isCurrentAccountAnswer": boolean
    }
  ],
  "date": "string"
}

{
    "error": "string"
}

juniorpaula / clean-architecture-nodejs Goto Github PK

clean-architecture-nodejs's Introduction

API de Enquetes

Instruções para rodar o projeto

Testes

Documentação

Principais funcionalidades

Endpoints da aplicação

Rota de Cadastro

Request body

Responses

Rota de Login

Request body

Responses

Rota de Criar enquetes private

Parameters in header

Request body

Responses

Rota de Listar enquetes private

Parameters in header

Responses

Rota para criar resposta de uma enquete private

Parameters in header

Parameters in route

Request body

Responses

Rota para consultar o resultado de uma enquete private

Parameters in header

Parameters in route

Responses

clean-architecture-nodejs's People

Contributors

Stargazers

Watchers

Recommend Projects

Recommend Topics

Recommend Org