{"id":31702059,"url":"https://github.com/instruct-br/notificador","last_synced_at":"2025-10-08T21:11:22.369Z","repository":{"id":197984749,"uuid":"699499004","full_name":"instruct-br/notificador","owner":"instruct-br","description":"O Notificador é uma aplicação FastAPI  e é uma ilustração de um sistema de notificações.","archived":false,"fork":false,"pushed_at":"2023-10-03T11:49:47.000Z","size":28,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2023-10-03T22:29:59.706Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/instruct-br.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-10-02T18:51:46.000Z","updated_at":"2023-10-03T22:30:02.462Z","dependencies_parsed_at":null,"dependency_job_id":"5b84ff52-fafe-4294-8ea4-f6368c23a31c","html_url":"https://github.com/instruct-br/notificador","commit_stats":null,"previous_names":["instruct-br/notificador"],"tags_count":null,"template":null,"template_full_name":null,"purl":"pkg:github/instruct-br/notificador","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instruct-br%2Fnotificador","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instruct-br%2Fnotificador/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instruct-br%2Fnotificador/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instruct-br%2Fnotificador/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/instruct-br","download_url":"https://codeload.github.com/instruct-br/notificador/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/instruct-br%2Fnotificador/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000716,"owners_count":26082837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-10-08T21:11:18.386Z","updated_at":"2025-10-08T21:11:22.362Z","avatar_url":"https://github.com/instruct-br.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Notificador\n\nO Notificador é uma aplicação FastAPI que serve como uma demonstração de um sistema de notificações. Essa aplicação é capaz de enviar notificações tanto por e-mail quanto por webhook (integrações com ferramentas como Mattermost e Slack). Além disso, o projeto ilustra o uso do RabbitMQ com a biblioteca aio-pika e também do MongoDB.\n\n## Como Usar\n\n### Clonando o Repositório\n\nClone o repositório para a sua máquina local:\n\n```shell\ngit clone https://github.com/seu-usuario/notificador.git\ncd notificador\n```\n\n### Configuração do Ambiente\n\nCertifique-se de que você possui o Docker e o Docker Compose instalados. \n\nCrie um arquivo `.env` no diretório raiz do projeto. Você pode copiar o arquivo `.env.sample` disponível e editá-lo conforme necessário.\n\nSe você planeja utilizar o serviço de envio de e-mail, configure uma conta no SendGrid e forneça as seguintes variáveis de ambiente no arquivo `.env`:\n\n```env\nSENDGRID_API_KEY=SuaChaveAPI\nSMTP_REMETENTE=seu-email@example.com\n```\n\n### Executando o Projeto\n\nNo terminal, execute o seguinte comando para construir e iniciar os contêineres Docker:\n\n```shell\ndocker-compose up -d --build\n```\n\nUma vez que a aplicação esteja em execução, a documentação Swagger dos endpoints estará automaticamente disponível em `http://localhost:8080/docs`. Você pode usar essa documentação para testar os endpoints.\n\n## Endpoints\n\nA aplicação oferece os seguintes endpoints:\n\n### 1. Cadastro de Notificações\n\n- Método: POST\n- URL: `http://localhost:8080/notificacoes`\n- Payload: JSON com os seguintes atributos:\n  - `type`: Tipo de notificação, atualmente suporta os valores \"email\" e \"webhook\".\n  - `email`: E-mail que deve receber a notificação (obrigatório se o `type` for \"email\").\n  - `webhook`: URL do webhook para notificar (obrigatório se o `type` for \"webhook\").\n  - `titulo`: O título da notificação.\n  - `mensagem`: A mensagem que será notificada.\n\n### 2. Listagem de Notificações\n\n- Método: GET\n- URL: `http://localhost:8080/notificacoes`\n- Resposta: Retorna o ID da notificação, o título e o status. O status pode ser \"PENDENTE\", \"ENVIADA\" ou \"FALHA_AO_ENVIAR\".\n\n## Funcionamento Interno\n\nQuando o endpoint de cadastro de notificações é chamado, a aplicação salva os detalhes da notificação no MongoDB com o status \"PENDENTE\". Além disso, ela publica uma mensagem na fila \"disparo_notificacao\" do RabbitMQ utilizando a biblioteca aio-pika e, em seguida, retorna uma resposta.\n\nA própria aplicação consome a fila \"disparo_notificacao\", onde um consumidor assíncrono lida com o envio real da mensagem, seja por webhook ou por e-mail. Após o envio da notificação, o consumidor atualiza o status no MongoDB, marcando-o como \"ENVIADA\" em caso de sucesso ou \"FALHA_AO_ENVIAR\" em caso de erro. Tudo isso é feito de forma assíncrona com a ajuda da biblioteca asyncio.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstruct-br%2Fnotificador","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finstruct-br%2Fnotificador","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finstruct-br%2Fnotificador/lists"}