Documentação da API REST To-Do List

Desenvolvimento de uma aplicação (API REST) de lista de tarefas (To-Do List). A aplicação permite ao usuário criar uma nova tarefa, visualizar todas as tarefas e visualizar uma tarefa específica.

1º - Processo de Instalação e Configuração da Aplicação

Pré-requisitos

Certifique-se de que você possui os seguintes itens instalados em sua máquina:

• .NET SDK 6.0 (para o backend).
• Node.js 16.10.0 (para o frontend).
• Gerenciador de pacotes npm (utilizei a versão 7.24.0).
• Banco de dados SQL Server.

---

Passo a Passo para Instalação e Configuração

Clonar o Repositório

Clone o repositório para o seu ambiente local:

git clone https://github.com/Lucas-RM/to-do-list.git

Backend (C# - API REST)

1. Navegue até a pasta /backend no terminal.

2. Restaure as dependências do projeto com o comando:

   dotnet restore

3. Configure a conexão com o banco de dados no arquivo appsettings.json:

   "ConnectionStrings": {
       "DefaultConnection": "<sua-string-de-conexão-aqui>"
   }

   • Como está configurado:

       "ConnectionStrings": {
       	"SqlServer": "Server=localhost\\sqlexpress; initial Catalog=ToDoList; Integrated Security=True"
       }

4. Em Program.cs configure o banco de dados:

   builder.Services.AddDbContext<DbContexto>(options =>
    options.UseSqlServer(
        builder.Configuration.GetConnectionString("SqlServer")
    )); 

   • Verifique se o nome da string de conexão é o mesmo que está em appsettings.json -> "DefaultConnection" ou "SqlServer".

5. Configure a URL da Política CORS em Program.cs para a URL do frontend:

   policy.WithOrigins("http://localhost:8080") // URL do frontend
         .AllowAnyHeader()
         .AllowAnyMethod(); 

   • Verifique se a URL http://localhost:8080 é a mesma do frontend.

6. Execute as migrações para criar o banco de dados:

   dotnet ef database update

7. Inicie o servidor backend:

   dotnet run

   • O servidor será iniciado na URL https://localhost:7120 -> Verifique se a porta (7120) é a correta.

---

Frontend (Vue.js)

1. Navegue até a pasta /frontend no terminal.

2. Instale as dependências do projeto:

   npm install

3. Configure o Axios em /services/api.js com a URL do backend, por exemplo:

   import axios from 'axios'
   
   const api = axios.create({
   	baseURL: 'https://localhost:7120/',
   	timeout: 10000,
   });
   export default api

   • Verifique se a URL https://localhost:7120/ é a mesma do backend.

4. Inicie o servidor de desenvolvimento:

   npm run serve

   • O frontend será iniciado na URL padrão http://localhost:8080 -> Verifique se a porta (8080) é a correta.

Testando a Aplicação

1. Abra o navegador e acesse o frontend em http://localhost:8080.
2. Utilize as funcionalidades disponíveis na interface para interagir com a API.

---

2º - Documentação dos Endpoints da API REST

Criar uma Nova Tarefa

Descrição: Adiciona uma nova tarefa à lista.

• URL: /tarefas/criar
• Método: POST
• Corpo da Requisição (Body > raw (json)):

  {
      "titulo": "string",
      "descricao": "string",
      "status": "int" (0 = Pendente, 1 = Em Andamento, 2 = Concluida)
  }

• Resposta:
  • Sucesso: Código 201 (Created)

    {
        "id": "int",
        "titulo": "string",
        "descricao": "string",
        "status": "int"
    }

  • Erro: Código 400 (Bad Request)

---

Visualizar Todas as Tarefas

Descrição: Retorna uma lista de todas as tarefas.

• URL: /tarefas
• Método: GET
• Resposta:
  • Sucesso: Código 200 (OK)

    [
        {
            "id": "int",
            "titulo": "string",
            "descricao": "string",
            "status": "int"
        }
    ]

  • Erro: Código 500 (Internal Server Error)

---

Visualizar uma Tarefa Específica

Descrição: Retorna os detalhes de uma tarefa específica com base no ID fornecido.

• URL: /tarefas/:id
• Método: GET
• Parâmetros da URL:
  • id (int): ID da tarefa.
• Resposta:
  • Sucesso: Código 200 (OK)

    {
        "id": "int",
        "titulo": "string",
        "descricao": "string",
        "status": "int"
    }

  • Erro:
    • Código 404 (Not Found): Tarefa não encontrada.
    • Código 500 (Internal Server Error).

---

3º - Arquivos do Postman

Os arquivos do Postman estão disponíveis em Postman Collection.

Conteúdo da Pasta

A pasta "Postman Collection" contém:

• Coleções do Postman: Arquivos .json que incluem todas as requisições configuradas para os endpoints da API.

• Documentação de Requisições: Parâmetros, corpos de requisição e exemplos de respostas para facilitar o teste e a validação da API.

Como Usar

1. Baixe os arquivos da pasta "Postman Collection".

2. Importe os arquivos no Postman:

   • Abra o Postman.

   • Clique em "Import" no canto superior esquerdo.

   • Selecione o arquivo .json baixado.

3. Utilize as requisições configuradas para testar a API com facilidade.