Sobre esta documentação
Um portal independente, com referência gerada a partir do contrato da API Expedit.
Uma fonte para a referência
As páginas da API são geradas a partir do grupo API de Integração publicado pelo Java. O grupo reúne as rotas /v2/** expostas para integrações externas. Operações internas e legadas não integram o catálogo público.
Os títulos, descrições, parâmetros, modelos e respostas vêm da especificação. Exemplos sintetizados a partir dos schemas são identificados como ilustrativos.
Como o catálogo é atualizado
A cada build, o projeto consulta a especificação, converte Swagger 2 para OpenAPI 3 e gera as páginas estáticas. Há também uma cópia validada e versionável do contrato, para permitir builds sem conexão.
Quando o contrato muda, é necessário um novo build e publicação para atualizar o site. A data de captura aparece na visão geral da API. O repositório inclui automação de sincronização que pode ser conectada ao provedor de hospedagem.
Formato aberto, hospedagem flexível
O portal utiliza Next.js, React, TypeScript e Tailwind CSS. O build gera HTML, CSS e JavaScript estáticos, sem exigir um servidor Node em produção.
Você pode baixar a especificação OpenAPI para importar no seu cliente HTTP ou gerar um SDK com uma ferramenta de sua preferência.
Precisa de ajuda?
Para acesso à API e dúvidas sobre a sua conta, fale com a equipe da Expedit pelos canais de atendimento disponíveis na plataforma ou no site oficial.