feat: Adição de funcionalidade de busca para feriados municipais, estaduais e nacionais.#555
feat: Adição de funcionalidade de busca para feriados municipais, estaduais e nacionais.#555LuisLourenco1 wants to merge 8 commits intoBrasilAPI:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Kudos, SonarCloud Quality Gate passed!
|
|
Bom dia mestre, primeiramente muito obrigado pela contribuição! ❤️ Eu confesso que to num dilema sobre a decisão de como organizar essa rota =S Hoje o recurso é feriados por ano e se a gnt fosse seguir pela mesma linha eu esperava que year continuasse sendo parametro de URL e state e city ser querystring só que se a gnt seguir nesse caminho eu fico no dilema se ao fazer a request sem parametro de estado e cidade a gnt talvez devesse retornar tudo referente ao ano (incluindo feriados munincipais e estaduais) Da forma que vc propos fica bem claro que se vc não pedir feriados estaduais ou munincipais estamos falando exclusivamente sobre feriados nacionais mas tem uma mudancinha maior na estrutura da rota especialmente pensando em REST com multiplos níveis 🤔 |
|
Salve pessoal, tudo jóia? Alguma previsão para a release? Grato! |
|
aqui tem todos os feriados por municipio https://feriadosbancarios.febraban.org.br/Municipais/Listar |
|
Olá @LuisLourenco1, obrigado pela contribuição! Mas há um problema fundamental com a fonte de dados. Bloqueador: usa repositório GitHub pessoal como fonte de dados const url = `https://raw.githubusercontent.com/LuisLourenco1/feriados-brasil/master/dados/...`;A BrasilAPI não pode depender de repositórios GitHub pessoais como fonte de dados porque:
O mesmo problema foi apontado no PR #492 — é um critério bloqueador do projeto. O que aceitar como fonte de dados:
Para feriados municipais, como não há API oficial pública e gratuita, a opção seria hardcodar os dados diretamente no projeto — o que é trabalhoso mas sólido. Além disso:
|
Issues relacionadas: #380 e #541
Descrição
A issue #380 referente ao repositório Brasil API visa discutir a possibilidade de implementação de uma integração de informações de feriados municipais na API, facilitando assim a realização de possíveis cálculos gerais.
A issue #541 por sua vez abre ideia para a necessidade de se desenvolver a funcionalidade de listar feriados por estado, possibilitando assim acompanhar as datas de feriados em um escopo geográfico maior do que os apresentados na issue #380.
Resolução
Requisição de dados
Para a implementação do que foi discutido nesta Issue, foi realizado uma recuperação de informações a partir do repositório feriados-brasil, presentes no endereço https://github.com/LuisLourenco1/feriados-brasil, que é mantido por nós mesmos (Contém os feriados de 2010 até 2025, onde deve atualizado antes de 2025). A partir da recuperação das informações contidas neste repositório, foram realizadas requisições HTTP para coletar as informações dos feriados municipais, expressas em arquivos JSON.
Implementação e Integração no Brasil API
Rotas:
/api/feriados/v2?year=2023Retorna os feriados nacionais de 2023.
Caso o ano não seja passado, será considerado o ano atual.
/api/feriados/v2/ms?year=2022Retorna os feriados do estado de Mato Grosso do Sul em 2022.
/api/feriados/v2/ms/trêslagoasRetorna os feriados da cidade de Três Lagoas no ano atual