OpenAPI

OpenAPI é uma especificação padrão do setor para descrever APIs. Utilizamos o OpenAPI para descrever todas as nossas APIs e também disponibilizamos essas especificações ao público.

Como encontrar uma especificação OpenAPI

Cada um dos nossos produtos possui sua própria especificação OpenAPI. A maneira mais fácil de encontrá-la é na referência da API — na parte superior da página, você encontrará a opção “Baixar especificação OpenAPI”, onde poderá baixar a referência da API. As próprias páginas de referência da API são geradas a partir dessas especificações.

Cada especificação está disponível em ambos os formatos YAML e JSON formatos; você pode visualizá-los com um editor de texto simples.

Use uma especificação OpenAPI em seus próprios projetos

Ter a descrição OpenAPI de uma API com a qual você deseja se integrar pode facilitar muito as coisas! Aqui estão algumas sugestões que você talvez queira experimentar:

Documentação local

Seja porque você está trabalhando com uma conexão instável ou porque prefere manter as coisas simples, uma especificação OpenAPI contém todas as informações necessárias para que você possa executar um aplicativo local e visualizar a documentação. ReDoc é um exemplo de ferramenta de documentação de código aberto que você pode usar para visualizar a especificação da API.

Coleções do Postman

A Vonage possui uma coleção dedicada no Postman para nossas APIs mais utilizadas. Você pode ler mais sobre isso no Guia do Postman.

Servidor simulado para testes com o Prism

Uma ferramenta que muitos de nossos desenvolvedores consideram útil é Prisma. É uma ferramenta de código aberto em JavaScript que aceita uma especificação OpenAPI e, em seguida, simula o comportamento da API descrita nela. É a maneira ideal de trabalhar com uma API local, evita o gasto de crédito da Account durante os testes e também oferece uma maneira de testar respostas de erro localmente.