OpenAPI

OpenAPI es una especificación estándar del sector para describir API. Utilizamos OpenAPI para describir todas nuestras API, y también ponemos esas especificaciones a disposición del público.

Encontrar una especificación OpenAPI

Cada uno de nuestros productos tiene su propia especificación OpenAPI. La forma más fácil de encontrarla es en la referencia de la API. parte superior de la página encontrará "Descargar especificación OpenAPI", donde podrá descargar la referencia API. Las propias páginas de referencia de la API se generan a partir de estas especificaciones.

Cada especificación está disponible en YAML y JSON puede visualizarlos con un editor de texto plano.

Utilice una especificación OpenAPI en sus propios proyectos

Disponer de la descripción OpenAPI de una API con la que desee integrarse puede facilitarle mucho las cosas. He aquí algunas sugerencias que puede probar:

Documentación local

Tanto si trabaja con una conexión deficiente como si prefiere no complicarse la vida, una especificación OpenAPI contiene toda la información necesaria para poder ejecutar una aplicación local que muestre la documentación. ReDoc es un ejemplo de herramienta de documentación de código abierto que puede utilizar para consultar la especificación de la API.

Colecciones Postman

Si ya es Cartero puede que le interese. Si no, dale una una oportunidad.

1. Descargue la especificación de la API que le interesa (a través de la página de referencia de la API)
2. En Postman, haga clic en "Importar" y seleccione el archivo *.yml archivo que ha descargado

.... eso es todo. Ya tienes un conjunto de solicitudes listas para realizar contra la API, ahora agrega los detalles de tu Account de Vonage y y ¡listo!

Servidor simulado para pruebas con Prism

Una herramienta que muchos de nuestros desarrolladores encuentran útil es Prisma. Es una herramienta JavaScript de código abierto que acepta una especificación OpenAPI e imita el comportamiento de la API que describe. Es una forma ideal de trabajar con una API local, evita el uso de crédito de la Account cuando se está probando algo, y también proporciona una manera de probar las respuestas de error localmente. localmente.