Skip to content

Latest commit

 

History

History
291 lines (231 loc) · 13.9 KB

backend-apis.md

File metadata and controls

291 lines (231 loc) · 13.9 KB

APIs e Web Services

A API e Web Service do projeto "GerenciamentoApiRest" oferece funcionalidades de gerenciamento de tarefas e projetos, permitindo criar, atribuir, e acompanhar atividades de forma colaborativa. A arquitetura RESTful, com autenticação via JWT e banco de dados PostgreSQL, garante segurança e escalabilidade. É uma solução eficiente para organizar e monitorar projetos em equipe.

Objetivos da API

API Gerenciamento de Tarefas: Objetivo: Prover funcionalidades para gerenciamento de projetos e tarefas, voltado ao público que necessita ter um controle melhor sobre projetos ou atividades cotidianas.

  • Facilitar a criação e gestão de projetos e tarefas.
  • Fornecer um meio para acompanhar o progresso das tarefas atribuídas a diferentes usuários.
  • Permitir a integração com outros serviços, como Google Agenda, para acompanhar os prazos e status das atividades.
  • Implementar autenticação e autorização para garantir que somente usuários autorizados possam acessar e modificar os dados.

Arquitetura

A arquitetura das APIs do projeto "GerenciamentoApiRest" é baseada em uma estrutura RESTful, proporcionando uma comunicação eficiente e organizada entre o cliente e o servidor para gerenciamento de tarefas e projetos. A seguir estão os principais componentes e suas interações:

  • API RESTful Desenvolvida com ASP.NET Core, seguindo os princípios de APIs RESTful para permitir a criação, leitura, atualização e exclusão de dados de forma organizada. Modelo de Dados
  • Usuário: Contém informações dos usuários, como nome, e-mail, senha e perfil (Administrador ou Cliente).
  • Projeto: Representa projetos que contêm várias tarefas, com informações como título, descrição e data de criação.
  • Tarefa: Contém os detalhes das atividades atribuídas aos projetos, incluindo título, descrição, prioridade, status (não iniciada, em andamento, finalizada), usuário atribuído e prazo de conclusão.
  • DTOs (Data Transfer Objects) Utilizados para transferir dados entre a API e o cliente, garantindo que apenas as informações necessárias sejam transmitidas, melhorando a eficiência e a segurança da aplicação.
  • Dados Utiliza o Entity Framework Core para gerenciar as interações com o banco de dados PostgreSQL, permitindo a persistência de dados de forma segura e estruturada.
  • Autenticação e Segurança Implementa autenticação e autorização por meio de JWT (JSON Web Token) para proteger os endpoints da API. As senhas dos usuários são armazenadas de forma segura utilizando BCrypt para hash, garantindo a integridade e proteção dos dados sensíveis.
  • Interações Requisições do Cliente: O cliente faz requisições HTTP (GET, POST, PUT, DELETE) para a API, interagindo com os recursos de usuários, projetos e tarefas. Controle de Dados: Os controladores (Controllers) da API processam as requisições, validam os dados recebidos e utilizam os serviços e repositórios para manipular os dados no banco de dados.
  • Fluxo de Dados:

Criação de Tarefa:

O cliente envia uma requisição POST com os dados da nova tarefa. O controlador de Tarefas (TarefasController) valida a requisição e encaminha a tarefa ao serviço (TarefaService) para ser processada. A tarefa é persistida no banco de dados via Entity Framework Core. A API retorna uma resposta de sucesso com os detalhes da tarefa criada.

Esta arquitetura modular e organizada facilita o desenvolvimento e a manutenção da aplicação, garantindo que a API seja segura, eficiente e escalável, atendendo aos requisitos de gerenciamento de projetos e tarefas de forma robusta.

Modelagem da Aplicação

1. Estrutura de Dados e Relacionamentos

Usuário:

Entidade que armazena os dados dos usuários, com atributos como: Id: Identificador único. Nome: Nome completo do usuário. Email: Utilizado para autenticação e contato. Senha: Armazenada de forma segura utilizando BCrypt. Perfil: Pode ser Administrador ou Cliente, definindo o nível de acesso. Projeto:

Representa um projeto que contém várias tarefas. Cada projeto tem atributos como: Id: Identificador único. Título: Nome do projeto. Descrição: Descrição do escopo do projeto. Data de Criação: Data em que o projeto foi criado. Usuários Relacionados: Associação dos usuários participantes do projeto, permitindo a colaboração.

Tarefa:

Entidade que representa uma atividade específica vinculada a um projeto. A tarefa possui: Id: Identificador único da tarefa. Título: Nome da tarefa. Descrição: Informações detalhadas sobre a atividade. Prioridade: Definida como baixa, média ou alta. Status: Indica o estado da tarefa (não iniciada, em andamento, finalizada). Usuário Atribuído: Identificador do usuário responsável por realizar a tarefa. Data de Vencimento: Prazo para a conclusão da tarefa. Datas de Criação e Atualização: Controle temporal da criação e modificações da tarefa.

2. Relacionamento entre Entidades

Usuário - Projeto:

Relacionamento muitos-para-muitos, em que um usuário pode participar de vários projetos, e um projeto pode ter vários usuários envolvidos.

Projeto - Tarefa:

Relacionamento um-para-muitos, em que um projeto pode conter várias tarefas, mas cada tarefa está vinculada a um único projeto.

Usuário - Tarefa:

Relacionamento um-para-muitos, em que um usuário pode ser responsável por várias tarefas, mas cada tarefa é atribuída a um único usuário.

3. Representação Visual (Diagramas de Classes/Entidades)

Diagrama de Entidade-Relacionamento (ER): O Diagrama ER ilustra como as entidades (Usuário, Projeto, Tarefa) se relacionam entre si, mostrando as chaves primárias (Id) e chaves estrangeiras que ligam essas entidades. Cada entidade é representada com seus atributos principais, e as linhas conectando as entidades indicam os relacionamentos (um-para-muitos ou muitos-para-muitos).

4. DTOs (Data Transfer Objects)

São utilizados para garantir que apenas os dados necessários sejam transferidos entre o cliente e a API. Por exemplo, ao retornar informações de um usuário, o DTO pode omitir a senha, enviando apenas nome, email e perfil, garantindo maior segurança.

5. Entity Framework Core

ORM (Object-Relational Mapping) que é utilizado para a comunicação com o banco de dados PostgreSQL, facilitando a persistência e manipulação dos dados. As classes representando Usuário, Projeto e Tarefa são mapeadas para tabelas no banco de dados, e o Entity Framework Core cuida de criar, ler, atualizar e excluir esses registros.

6. Segurança dos Dados

Autenticação: Utiliza JWT (JSON Web Token) para autenticar os usuários, garantindo que apenas aqueles autorizados possam acessar a API. Armazenamento de Senhas: As senhas são armazenadas utilizando hash BCrypt, o que evita que dados sensíveis sejam expostos em caso de vazamento.

Fluxo de Dados

arq

1. Usuário faz uma requisição:

O usuário interage com o sistema, enviando uma requisição (ex.: acessa uma URL para criar uma nova tarefa).

2. Controller (Controlador):

O controlador recebe a requisição do usuário e a interpreta. Valida os dados e verifica se a operação solicitada é permitida. Envia a solicitação para o Model para realizar as operações necessárias.

3. Model (Modelo):

O model realiza as operações com os dados, como acessar o banco de dados, fazer validações, ou aplicar regras de negócio. Se necessário, o model acessa o Banco de Dados para recuperar, armazenar, ou atualizar informações.

4. Banco de Dados:

O banco de dados responde às operações solicitadas pelo model (ex.: salvar uma nova tarefa, retornar uma lista de tarefas).

5. Model retorna ao Controller:

O model retorna os dados processados para o controlador, após completar a solicitação.

5. Controller retorna ao Usuário:

O controlador então retorna uma resposta adequada ao usuário, podendo ser um sucesso, erro ou os dados requisitados (ex.: confirmação da criação da tarefa).

Requisitos Funcionais

ID Descrição do Requisito Prioridade
RF-001 Permitir que o usuário cadastre tarefas ALTA
RF-002 Emitir um relatório de tarefas realizadas no mês MÉDIA
RF-003 Permitir que o usuário categorize e priorize tarefas MÉDIA
RF-004 Permitir a integração com calendários digitais (Google Calendar, Outlook, etc.) ALTA
RF-005 Permitir que o usuário compartilhe tarefas com outros usuários MÉDIA
RF-006 Permitir que o usuário receba notificações de prazos e lembretes de tarefas MÉDIA
RF-007 Permitir que o usuário anexe arquivos ou notas às tarefas MÉDIA

Requisitos Não Funcionais

ID Descrição do Requisito Prioridade
RNF-001 Deve possuir uma interface responsiva que funcione bem em dispositivos móveis e Web. MÉDIA
RNF-002 Deve processar requisições do usuário em no máximo 3s BAIXA
RNF-003 O sistema deve ser intuitivo e fácil de usar, garantindo uma boa experiência aos usuários. MÉDIA
RNF-004 A plataforma deve ser compatível com os principais navegadores (Chrome, Firefox, Safari) MÉDIA

Tecnologias Utilizadas

  • Back-end: ASP.NET Core 6.0
  • Banco de Dados: PostgreSQL
  • ORM: Entity Framework Core
  • Autenticação: JWT (JSON Web Token)
  • Documentação: Swagger
  • Controle de Versão: Git

API Endpoints

Endpoint 1

  • Método: POST

  • URL: /api/Usuarios/register

  • Parâmetros: Sem Parametros

  • Corpo da Requisição:

     {
"id": 0,
"nome": "Pessoa1",
"email": "[email protected]",
"senha": "SenhaSegura@123"}

  • Resposta:

    • Sucesso (201 CREATED)
    {
 "$id": "1",
 "nome": "Pessoa1",
 "email": "[email protected]",
 "senha": "$2a$11$WnPB5LqYL5TqOr57JNqNTeHO2fWdR4j6sJO7QzVU60LMu7tpMAtjG",
 "perfil": 1,
 "perfilDescricao": "Cliente",
 "id": 4
}

- Corpo da Requisição:
```json
 {
"id": 0,
"nome": "Pessoa1",
"email": "[email protected]",
"senha": "Senh"}

- Resposta:

- 400 Bad Request
 {
 "$id": "1",
 "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
 "title": "One or more validation errors occurred.",
 "status": 400,
 "errors": {
     "$id": "2",
     "Senha": [
         "A senha deve ter pelo menos 8 caracteres."
     ]
 },
 "traceId": "00-fee99bfcd684fa34c704557dcd967cae-ff439ed4a936c69a-00"}


### Endpoint 2

  • Método: GET

  • URL: /api/Tarefas

  • Parâmetros: Sem Parametros

    • Resposta:
    {
  "$id": "1",
  "items": {
      "$id": "2",
      "$values": [
          {
              "$id": "3",
              "tarefaId": 0,
              "titulo": "string",
              "descricao": "string",
              "prioridade": 0,
              "status": 0,
              "usuarioAtribuido": 0,
              "dataVencimento": "2024-09-28T21:27:00.983Z",
              "criadoEm": "2024-09-28T21:27:00.983Z",
              "atualizadoEm": "2024-09-28T21:27:00.983Z",
              "id": 1
          },
          {
              "$id": "4",
              "tarefaId": 0,
              "titulo": "string",
              "descricao": "string",
              "prioridade": 0,
              "status": 0,
              "usuarioAtribuido": 0,
              "dataVencimento": "2024-09-28T21:11:21.933Z",
              "criadoEm": "2024-09-28T21:11:21.933Z",
              "atualizadoEm": "2024-09-28T21:11:21.933Z",
              "id": 2
          }
      ]
  },
  "currentPage": 1,
  "pageSize": 10,
  "totalCount": 2}

Considerações de Segurança

Para garantir a segurança da aplicação adotamos diversas medidas de proteção, focadas em autenticação, autorização.

Autenticação:

O sistema utiliza JWT (JSON Web Token), implementado com o pacote JWTBearer, para autenticação segura dos usuários. Ao fazer login, o usuário recebe um token que é utilizado nas solicitações subsequentes para identificar e autenticar o acesso. Esse token é assinado de forma criptografada, garantindo que não possa ser alterado sem a chave de assinatura.

Autorização:

A autorização é tratada por meio de políticas e claims definidas nos tokens JWT. Essas claims indicam o nível de acesso do usuário, garantindo que ele tenha permissões adequadas para acessar recursos específicos.

Implantação

[Instruções para implantar a aplicação distribuída em um ambiente de produção.]

  1. Defina os requisitos de hardware e software necessários para implantar a aplicação em um ambiente de produção.
  2. Escolha uma plataforma de hospedagem adequada, como um provedor de nuvem ou um servidor dedicado.
  3. Configure o ambiente de implantação, incluindo a instalação de dependências e configuração de variáveis de ambiente.
  4. Faça o deploy da aplicação no ambiente escolhido, seguindo as instruções específicas da plataforma de hospedagem.
  5. Realize testes para garantir que a aplicação esteja funcionando corretamente no ambiente de produção.

Testes

Para os testes utilizaremos o Postman. Será realizado o registro de um usuário, após o registro esse usuário fará o login e depois irá criar uma tarefa. Captura de Tela (47) Captura de Tela (48) Captura de Tela (49)

Referências