Inova Relay transforma contrato OpenAPI em SDK TypeScript com validação das respostas

O Inova Relay passou a oferecer um cliente TypeScript gerado a partir do contrato OpenAPI da API pública. A ferramenta valida as respostas recebidas pelo sistema que faz a integração e exige cabeçalhos obrigatórios antes de enviar requisições à rede. A mudança interessa a equipes de desenvolvimento, operação e TI que incorporam recursos de atendimento em seus próprios produtos.

Na prática, o integrador deixa de depender de uma camada escrita manualmente para cada operação. Quando uma nova operação entra no contrato, ela pode aparecer no cliente gerado. O SDK também expõe métodos tipados, em vez de uma coleção genérica de funções, o que permite detectar no desenvolvimento o uso de uma operação inexistente.

A validação ocorre nos dois sentidos. O cliente confere se a resposta tem os campos previstos e recusa tanto a ausência de um campo obrigatório quanto a presença de um campo que o contrato não permite. Essa conferência é feita por quem consome a API, e não apenas pelo serviço que a fornece.

Os cabeçalhos obrigatórios também deixam de ser uma orientação documental. Entre eles está o `If-Match`, usado em ações sobre chamadas para confirmar que o cliente está trabalhando com a versão mais recente do recurso. Quando a precondição não é atendida, a API utiliza uma resposta específica para indicar que o estado precisa ser lido novamente antes de uma nova decisão.

O pacote inclui ainda um exemplo executável que cria um contato, abre uma conversa, envia uma mensagem e acompanha os eventos usando somente a API pública. O exemplo é executado na suíte de integração e as respostas são validadas pelo próprio cliente durante o percurso.

A cobertura publicada alcança as 18 operações da API pública que possuem corpo declarado no contrato. Com isso, o contrato OpenAPI passa a orientar não apenas a documentação, mas também a geração do cliente e a conferência do que chega ao integrador.