Skip to content

244Walyson/GWApp

Repository files navigation

GWApp

Build gitlab

Voĉe tambem pode ver os arquivos de implantação dessa aplicação no gitlab

Este repositório contém a documentação das APIs do Kanban, chat-service, notification-service. As APIs permitem gerenciar usuários, times, boards e cards, chat entre usuarios e envio de notificações um sistema que é uma espécie de Kanban.

Base URL

https://waly1-kanban-service.api.waly.dev.br

Endpoints

kanban

se estiver rodando localmente pode acessar ao path /swagger-ui/index.html*

Notification

Para ver os endpoints do serviço de notificação basta colar está linha na barra de pesquisa da pagina do swagger ou acessando localmente no path /swagger-ui/index.html

https://raw.githubusercontent.com/244Walyson/Kanban-services/swagger/open-api-notification.json

Chat

Ultiliza websockets junto ao protocolo STOMP (Simple Text Oriented Messaging Protocol)

O protocolo STOMP é um protocolo de mensagens simples e orientado a texto, projetado para interoperabilidade entre diferentes sistemas de mensagens. Ele fornece uma maneira simples de enviar e receber mensagens entre clientes e servidores por meio de uma conexão WebSocket.

Ao usar o protocolo STOMP:

Os clientes podem se conectar a um servidor WebSocket e subscrever a canais específicos (destinos).
Os clientes podem enviar e receber mensagens em tempo real por meio desses canais.
As mensagens geralmente são formatadas como texto simples, facilitando a leitura e a interpretação.

para o chat temos os seguintes endpoints:

/connect?token=

abre uma conexão websocket

Endpoints do Controlador WebSocket (STOMP)

/chat (STOMP)

  • Descrição: Este endpoint recebe e processa mensagens de chat usando o protocolo STOMP.
  • Funcionalidade:
    • Os clientes podem enviar mensagens de chat para este endpoint e recebê-las em tempo real.
  • Autorização: Não requer autorização.

/chat/{roomId} (STOMP)

  • Descrição: Este endpoint recebe e processa mensagens de chat para uma sala de chat específica usando o protocolo STOMP.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes podem enviar mensagens de chat para uma sala de chat específica e recebê-las em tempo real.
  • Autorização: Requer autenticação do usuário.

/{roomId}/queue/messages (STOMP)

  • Descrição: Neste endpoint o cliente pode se conectar para receber as Mensagens das salas de chat que ele esta participando.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes recebem mensagens de chat das salas que ele participa.
  • Autorização: Requer autenticação do usuário.

/{nick}/queue/chats (STOMP)

  • Descrição: Neste endpoint o cliente pode se conectar para receber as atualizações das salas de chat que ele esta participando.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes recebem Atualizações de chat das salas que ele participa quando.
  • Autorização: Requer autenticação do usuário.

Rodando a aplicação localmente com docker

git clone -b local [email protected]:244Walyson/Kanban-services.git
cd Kanban-services
docker-compose up --build -d

Após o container kafka Connect subir instale o conector do mysql

cd Kubernets-Docker-Configs/kafka-connect
curl -i -X POST -H "Accept:application/json" -H  "Content-Type:application/json" http://localhost:8083/connectors/ -d @mysql.json
cd .. && cd ..

=======

Kanban Application API

=======

Kanban Api

Consiste em três serviços, kanban, chat e notification

9b6a719 (Update README.md)

Build gitlab

Voĉe tambem pode ver os arquivos de implantação dessa aplicação no gitlab

<<<<<<< HEAD A API da Aplicação Kanban fornece endpoints para gerenciar diversos recursos dentro da aplicação, incluindo usuários, equipes, quadros e tarefas. Esta documentação descreve os principais endpoints, seus parâmetros de requisição e respostas esperadas.

dc5b95f (Update README.md) ======= Este repositório contém a documentação das APIs do Kanban, chat-service, notification-service. As APIs permitem gerenciar usuários, times, boards e cards, chat entre usuarios e envio de notificações um sistema que é uma espécie de Kanban. 9b6a719 (Update README.md)

Base URL

https://waly1-kanban-service.api.waly.dev.br

Endpoints

kanban

se estiver rodando localmente pode acessar ao path /swagger-ui/index.html*

Notification

Para ver os endpoints do serviço de notificação basta colar está linha na barra de pesquisa da pagina do swagger ou acessando localmente no path /swagger-ui/index.html

https://raw.githubusercontent.com/244Walyson/Kanban-services/swagger/open-api-notification.json

Chat

Ultiliza websockets junto ao protocolo STOMP (Simple Text Oriented Messaging Protocol)

O protocolo STOMP é um protocolo de mensagens simples e orientado a texto, projetado para interoperabilidade entre diferentes sistemas de mensagens. Ele fornece uma maneira simples de enviar e receber mensagens entre clientes e servidores por meio de uma conexão WebSocket.

Ao usar o protocolo STOMP:

Os clientes podem se conectar a um servidor WebSocket e subscrever a canais específicos (destinos).
Os clientes podem enviar e receber mensagens em tempo real por meio desses canais.
As mensagens geralmente são formatadas como texto simples, facilitando a leitura e a interpretação.

para o chat temos os seguintes endpoints:

/connect?token=

abre uma conexão websocket

Endpoints do Controlador WebSocket (STOMP)

/chat (STOMP)

  • Descrição: Este endpoint recebe e processa mensagens de chat usando o protocolo STOMP.
  • Funcionalidade:
    • Os clientes podem enviar mensagens de chat para este endpoint e recebê-las em tempo real.
  • Autorização: Não requer autorização.

/chat/{roomId} (STOMP)

  • Descrição: Este endpoint recebe e processa mensagens de chat para uma sala de chat específica usando o protocolo STOMP.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes podem enviar mensagens de chat para uma sala de chat específica e recebê-las em tempo real.
  • Autorização: Requer autenticação do usuário.

/{roomId}/queue/messages (STOMP)

  • Descrição: Neste endpoint o cliente pode se conectar para receber as Mensagens das salas de chat que ele esta participando.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes recebem mensagens de chat das salas que ele participa.
  • Autorização: Requer autenticação do usuário.

/{nick}/queue/chats (STOMP)

  • Descrição: Neste endpoint o cliente pode se conectar para receber as atualizações das salas de chat que ele esta participando.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes recebem Atualizações de chat das salas que ele participa quando.
  • Autorização: Requer autenticação do usuário.

Rodando a aplicação localmente com docker

git clone -b local [email protected]:244Walyson/Kanban-services.git
cd Kanban-services
docker-compose up --build -d

Após o container kafka Connect subir instale o conector do mysql

cd Kubernets-Docker-Configs/kafka-connect
curl -i -X POST -H "Accept:application/json" -H  "Content-Type:application/json" http://localhost:8083/connectors/ -d @mysql.json
cd .. && cd ..

=======

Kanban Application API

=======

Kanban Api

Consiste em três serviços, kanban, chat e notification

de90ef1 (Update README.md)

Build gitlab

Voĉe tambem pode ver os arquivos de implantação dessa aplicação no gitlab

<<<<<<< HEAD A API da Aplicação Kanban fornece endpoints para gerenciar diversos recursos dentro da aplicação, incluindo usuários, equipes, quadros e tarefas. Esta documentação descreve os principais endpoints, seus parâmetros de requisição e respostas esperadas.

751970a (Update README.md) ======= Este repositório contém a documentação das APIs do Kanban, chat-service, notification-service. As APIs permitem gerenciar usuários, times, boards e cards, chat entre usuarios e envio de notificações um sistema que é uma espécie de Kanban. de90ef1 (Update README.md)

Base URL

https://waly1-kanban-service.api.waly.dev.br

Endpoints

kanban

se estiver rodando localmente pode acessar ao path /swagger-ui/index.html*

Notification

Para ver os endpoints do serviço de notificação basta colar está linha na barra de pesquisa da pagina do swagger ou acessando localmente no path /swagger-ui/index.html

https://raw.githubusercontent.com/244Walyson/Kanban-services/swagger/open-api-notification.json

Chat

Ultiliza websockets junto ao protocolo STOMP (Simple Text Oriented Messaging Protocol)

O protocolo STOMP é um protocolo de mensagens simples e orientado a texto, projetado para interoperabilidade entre diferentes sistemas de mensagens. Ele fornece uma maneira simples de enviar e receber mensagens entre clientes e servidores por meio de uma conexão WebSocket.

Ao usar o protocolo STOMP:

Os clientes podem se conectar a um servidor WebSocket e subscrever a canais específicos (destinos).
Os clientes podem enviar e receber mensagens em tempo real por meio desses canais.
As mensagens geralmente são formatadas como texto simples, facilitando a leitura e a interpretação.

para o chat temos os seguintes endpoints:

/connect?token=

abre uma conexão websocket

Endpoints do Controlador WebSocket (STOMP)

/chat (STOMP)

  • Descrição: Este endpoint recebe e processa mensagens de chat usando o protocolo STOMP.
  • Funcionalidade:
    • Os clientes podem enviar mensagens de chat para este endpoint e recebê-las em tempo real.
  • Autorização: Não requer autorização.

/chat/{roomId} (STOMP)

  • Descrição: Este endpoint recebe e processa mensagens de chat para uma sala de chat específica usando o protocolo STOMP.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes podem enviar mensagens de chat para uma sala de chat específica e recebê-las em tempo real.
  • Autorização: Requer autenticação do usuário.

/{roomId}/queue/messages (STOMP)

  • Descrição: Neste endpoint o cliente pode se conectar para receber as Mensagens das salas de chat que ele esta participando.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes recebem mensagens de chat das salas que ele participa.
  • Autorização: Requer autenticação do usuário.

/{nick}/queue/chats (STOMP)

  • Descrição: Neste endpoint o cliente pode se conectar para receber as atualizações das salas de chat que ele esta participando.
  • Parâmetros de entrada:
    • chatMessage: Objeto JSON representando a mensagem de chat a ser processada.
    • roomId: Identificador da sala de chat para a qual a mensagem está sendo enviada.
  • Funcionalidade:
    • Os clientes recebem Atualizações de chat das salas que ele participa quando.
  • Autorização: Requer autenticação do usuário.

Rodando a aplicação localmente com docker

git clone -b local [email protected]:244Walyson/Kanban-services.git
cd Kanban-services
docker-compose up --build -d

Após o container kafka Connect subir instale o conector do mysql

cd Kubernets-Docker-Configs/kafka-connect
curl -i -X POST -H "Accept:application/json" -H  "Content-Type:application/json" http://localhost:8083/connectors/ -d @mysql.json
cd .. && cd ..

URL Base

A URL base para todas as requisições da API é: se estiver rodando localmente:

http://localhost:8080

<<<<<<< HEAD <<<<<<< HEAD <<<<<<< HEAD <<<<<<< HEAD

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.

Contribuição

Contribuições são bem-vindas! Por favor, veja as diretrizes de contribuição para mais detalhes.

0e51d1c (change to monorepo) =======

Kanban

e96ba8b (Initial commit) ======= ======= 751970a (Update README.md) senão verifique se esta rodando em:

https://kanban.rancher.waly.dev.br

<<<<<<< HEAD

9182f51 (Update README.md)

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.

Contribuição

Contribuições são bem-vindas! Por favor, veja as diretrizes de contribuição para mais detalhes.

dc5b95f (Update README.md) =======

Kanban

e8dde2d (Initial commit) ======= ======= 4c72826 (Update README.md)

Licença

Este projeto está licenciado sob a Licença MIT - veja o arquivo LICENSE para detalhes.

Contribuição

Contribuições são bem-vindas! Por favor, veja as diretrizes de contribuição para mais detalhes.

751970a (Update README.md)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published