Importação de APIs
O TunnelHub permite importar definições de API para acelerar publicação, padronização e governança.
Objetivo da importação
Seção intitulada “Objetivo da importação”Importar uma API ajuda a:
- iniciar rapidamente a configuração de uma definição;
- reaproveitar especificações existentes;
- reduzir erros manuais na modelagem;
- alinhar documentação e configuração operacional.
O que normalmente faz parte do fluxo
Seção intitulada “O que normalmente faz parte do fluxo”- importar a especificação base;
- revisar rotas e configurações;
- associar autenticação quando necessário;
- vincular planos de uso, chaves de API, servidores de recursos e clientes;
- publicar e validar por Swagger ou chamadas reais.
Dependendo do caso, a importação é só o começo. Ainda pode ser necessário revisar tipos de API, documentação pública, estágios, monitoramento e exportação do contrato final.
Depois da importação
Seção intitulada “Depois da importação”Depois de importar, revise com atenção:
- segurança dos endpoints;
- políticas de consumo;
- publicação de documentação Swagger;
- monitoramento e observabilidade da API.
Também vale validar se o arquivo importado deve ser exportado novamente em outro formato, como OpenAPI 3, Swagger 2, JSON ou YAML, para distribuição ao time consumidor.
Recomendação
Seção intitulada “Recomendação”Considere a importação como ponto de partida. A definição final deve refletir a forma como a API será operada no TunnelHub, e não apenas o arquivo original.