Swagger UI Interativo¶
Exploração Interativa da API¶
O Swagger UI está disponível diretamente nos ambientes do SISBOV. Use os links abaixo para acessar a documentação interativa e também para fazer chamadas de teste diretamente pelo navegador.
Dica
Para testar endpoints no Swagger UI, primeiro autentique-se usando o botão Authorize e insira seu Bearer Token no formato: Bearer {{seu_token_jwt}}
Ambientes disponíveis¶
URL: https://api-cert-hmg-sisbov.agricultura.gov.br/swagger-ui
Use este ambiente para testes e validações antes de ir para produção. Nenhum dado real é afetado.
URL: swagger de produção não publicado
Atenção
Operações no ambiente de produção afetam dados reais de animais e propriedades no SISBOV. Utilize com responsabilidade.
Módulos da API no Swagger¶
O Swagger UI organiza os endpoints por tags de módulo:
| Tag | Path Raiz | Descrição |
|---|---|---|
Animal |
/integracao/animal |
Gestão completa de animais bovinos/bubalinos |
Propriedade |
/integracao/propriedade |
Cadastro e gestão de propriedades rurais |
Produtor |
/integracao/produtor |
Gestão de produtores rurais |
Proprietário |
/integracao/proprietario |
Gestão de proprietários |
Movimentação |
/integracao/movimentacao |
Transporte de animais |
GTA |
/integracao/gta |
Guia de Trânsito Animal |
Lote |
/integracao/lote |
Agrupamento de animais |
Numeração |
/integracao/numeracao |
Controle de números oficiais |
Solicitação de Numeração |
/integracao/solicitacaoNumeracao |
Solicitações de novos números |
Certificadora |
/integracao/certificadora |
Dados de certificadora |
Frigorífico |
/integracao/frigorifico |
Consulta de frigoríficos |
Técnico |
/integracao/tecnico |
Gestão de técnicos |
Vistoria |
/integracao/vistoria |
Vistorias de campo |
Ato de Solicitação |
/integracao/atoDeSolicitacao |
Processos administrativos |
Como usar o Swagger UI¶
Passo 1 — Autenticar¶
- Acesse o link do Swagger do ambiente desejado
- Clique no botão Authorize (cadeado 🔒) no topo da página
- Cole seu token no campo
BearerAuth: - Clique em Authorize e depois Close
Passo 2 — Testar um Endpoint¶
- Expanda o módulo desejado (ex:
Animal) - Expanda o endpoint que deseja testar (ex:
GET /animal/{id}) - Clique em Try it out
- Preencha os parâmetros obrigatórios
- Clique em Execute
- Veja a resposta na seção abaixo
OpenAPI Specification (JSON/YAML)¶
O arquivo de especificação OpenAPI pode ser baixado diretamente:
| Formato | Homologação | Produção |
|---|---|---|
| JSON | openapi.json (hom) | openapi.json (prod) |
| YAML | openapi.yaml (hom) | openapi.yaml (prod) |