{{ message }}
Repository navigation
fix(docs): preserva o prefixo /api na URL base da spec OpenAPI - #905
Open
marco-jardim wants to merge 1 commit into
Open
marco-jardim wants to merge 1 commit into
marco-jardim wants to merge 1 commit into
Conversation
…lAPI#903) O merge dos arquivos de documentacao usa lodash.merge, que combina arrays por indice. Como eleicoes.json declarava o proprio "servers" apontando para https://brasilapi.com.br, ele sobrescrevia o servers de basic_info.json (https://brasilapi.com.br/api). O Redoc passava a exibir todas as URLs sem o prefixo /api, retornando 404. - Remove o servers redundante de eleicoes.json - Extrai servers do merge em getJsonDoc, como ja era feito com x-tagGroups - Cobre o caso em tests/docs-spec-refs.test.js Closes BrasilAPI#903
|
RodriAndreotti
approved these changes
Sep 9, 2026
Contributor
MaxOliveiraJr
approved these changes
Sep 30, 2026
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.




Closes #903
Problema
As URLs exibidas no Redoc (
/docs) apareciam sem o prefixo/api— por exemplohttps://brasilapi.com.br/feriados/v1/{ano}em vez dehttps://brasilapi.com.br/api/feriados/v1/{ano}— e retornavam 404 ao serem seguidas.Causa raiz
services/getJsonDoc.jsmonta a spec única concatenando todos os arquivos depages/docs/doc/*.jsoncomlodash.merge, que combina arrays por índice.basic_info.jsondefine a URL base correta:Só que
eleicoes.jsontambém declarava umserverspróprio, sem o prefixo:Como
eleicoes.jsonvem depois debasic_info.jsonna ordem alfabética doreaddirSync, o merge por índice sobrescreviaservers[0].urle a spec inteira passava a apontar parahttps://brasilapi.com.br. O sintoma aparecia em todos os endpoints, não só em eleições.O que mudou
pages/docs/doc/eleicoes.json: remove o blocoserversredundante. A URL base da spec é responsabilidade dobasic_info.json. Isso também corrige as próprias rotas de eleições, que apontavam para/eleicoes/...quando as rotas reais são/api/eleicoes/....services/getJsonDoc.js: extraiserversdo merge, exatamente como já era feito comtagsex-tagGroups— os dois casos anteriores em que o merge de arrays do lodash causou problema. Sem isso, qualquer arquivo de doc que venha a declararserversvolta a quebrar a URL base de toda a documentação silenciosamente.tests/docs-spec-refs.test.js: teste cobrindo o caso, no arquivo que já testa a spec agregada.Como testei
Teste novo falhando antes da correção:
Depois da correção:
Lint, mesmo comando do workflow
e2e-tests.yml:Suíte completa:
As 2 falhas são em
tests/diasuteis-v1.test.jse não têm relação com esta mudança — reproduzi as mesmas duas falhas emupstream/mainsem nenhuma alteração aplicada (git stash+npm test -- tests/diasuteis-v1.test.js→2 failed | 6 passed). Não mexi nelas para não misturar escopo.Impacto de compatibilidade
Nenhum. A mudança afeta apenas a documentação renderizada e o serviço que a agrega. Nenhum handler de
pages/api/**, nenhum campo de resposta, nenhum status code e nenhuma URL de endpoint foram alterados. As URLs documentadas passam a coincidir com as rotas que já existiam.Desenvolvido com assistência de LLM, revisado e testado por mim.