docs: reorganizar o menu de documentação da API com grupos semânticos#795
docs: reorganizar o menu de documentação da API com grupos semânticos#795felipeflfranca wants to merge 1 commit intoBrasilAPI:mainfrom
Conversation
Groups all endpoints into semantic categories using ReDoc's x-tagGroups
extension, replacing the flat alphabetical list of 20+ tags with a
structured sidebar:
- Empresarial: CNPJ, NCM, Registro.br
- Financeiro: Banks, Câmbio, Corretoras, FIPE, Fundos, PIX, Taxas, Tickers
- Geográfico: CEP, CEP V2, CPTEC, DDD, IBGE
- Geral: Feriados Nacionais, ISBN
- Saúde: TUSS
- Termos de uso (kept first per existing convention)
Groups and items sorted alphabetically within each category.
Also reorganizes the "Recursos disponíveis" section in the API
description by category, adds missing "Fundos de investimento",
and normalizes names ("Tabela FIPE" → "FIPE", "Registros de
domínio br" → "Registro.br").
getJsonDoc.js updated to extract and assign x-tagGroups explicitly,
avoiding lodash array merge issues with arrays across multiple files.
No endpoints were changed — fully backward compatible.
|
@felipeflfranca is attempting to deploy a commit to the BrasilAPI Team on Vercel. A member of the Team first needs to authorize it. |
|
lucianopf
left a comment
There was a problem hiding this comment.
Boa contribuição! A reorganização do menu usando x-tagGroups é a abordagem idiomática do ReDoc e resolve bem o problema de navegabilidade com 20+ endpoints em lista plana.
Verifiquei todos os nomes de tags nos x-tagGroups contra os arquivos JSON individuais — todas as 20 tags batem corretamente. O fix em services/getJsonDoc.js para extrair x-tagGroups antes do lodash.merge também está correto e evita um potencial bug de duplicação de arrays.
Nenhum endpoint ou contrato de API foi alterado. Aprovado! ✅
|
Teve alguma função da API FIPE que tenha mudado, reparei que parou de contultar |
|
Oi @daccorrea ! Investiguei isso hoje e a API da FIPE ( O que acontece é que a API da FIPE tem instabilidade intermitente (retorna 403 ou 500 esporadicamente). Quando testei mais cedo hoje ela estava fora, mas agora voltou a responder. Você consegue dar mais detalhes? Qual endpoint específico está falhando pra você e qual erro está recebendo? Assim consigo investigar melhor se é algo pontual ou se mudou alguma coisa na API deles. |
muito obrigado pelo retorno eu estou usando o endpoint: https://brasilapi.com.br/api/fipe/preco/v1/001004-9 estou fazendo um mapeamento para identificar a quantidade de litros de um carro. com essa api da fipe consegui avançar um pouco mas acho que vou ter que recorrer a outra pois não tem as especificações técnicas do veículo. de toda forma eu acabei de consultar de novo e o resultado veio sem problema, estou usando o postman para fazer esses testes. |
📋 Descrição
Agrupa todos os endpoints em categorias semânticas usando a extensão
x-tagGroupsdo ReDoc, substituindo a lista alfabética plana de 20+ tags por uma barra lateral estruturada:Grupos e itens ordenados alfabeticamente dentro de cada categoria.
Também reorganiza a seção "Recursos disponíveis" na descrição da API por categoria, adiciona o item ausente "Fundos de investimento" e normaliza nomes ("Tabela FIPE" → "FIPE", "Registros de domínio br" → "Registro.br").
O
getJsonDoc.jsfoi atualizado para extrair e atribuirx-tagGroupsde forma explícita, evitando problemas de merge de arrays do lodash quando múltiplos arquivos JSON são combinados.Nenhum endpoint foi alterado — totalmente compatível com versões anteriores.
🎯 Tipo de Mudança
📚 Checklist de Documentação
/pages/docs/doc/🧪 Checklist de Testes
npm test)💻 Checklist de Código
npm run fixantes de commitar🚀 Checklist de Performance e Custos
🔍 Como Testar
npm install && npm run devhttp://localhost:3000/docs📝 Notas Adicionais
A extensão
x-tagGroupsé suportada nativamente pelo ReDoc, já utilizado no projeto. Não há novas dependências. A mudança é puramente de organização visual da documentação — nenhum endpoint, campo ou comportamento de API foi alterado.