Diagramação da nova API

[nickolasrm]

Descrição

Com as mudanças estruturais pedidas pela banca na aplicação é necessário que antes do desenvolvimento seja construido um diagrama de sequência bem como o planejamento dos payloads envolvidos na nova lógica do bakend.

Essa task é necessária pois permite ao frontend trabalhar sem a necessidade do backend estar pronto.

Algumas ferramentas que podem ajudar nesse trabalho:

• plantuml
• mermaid (Recomendo utilizar esse pois o Github tem compatibilidade nativa com mermaid)
• diagrams.net

Exemplo:

Diagrama de login:

sequenceDiagram
    User->>App: Efetua login
    App->>API: Envia credenciais
    API->>DB: Puxa user do banco
    DB-->>API: Credenciais
    API->>API: Validar
    alt valido
        API-->>App: Token
        App-->>User: Dashboard
    else invalido
        API-->>App: 403
        App-->>User: Mensagem de erro
    end

Payload:

interface Auth {
    email: string,
    password: string
}

Criterio de sucesso

• Entendimento do fluxo e validação pelo @cesarzxk
• Diagramas e payloads das rotas desde o cadastro até o fim do jogo

[davi-o-barbosa]

https://github.com/CITEI/Comunizika/pull/46