Generando APIs REST con OpenAPI & TypeScript

La forma en que creamos aplicaciones suele implicar construir una API REST con la que nos comunicamos sobre HTTP. Diseñamos contratos para esas API para definir la forma en la que operan. Para dar soporte a ello se propuso en 2011 la especificación Swagger IDL para convertirse después en 2016 en el estandar abierto OpenAPI ampliamente extendido.

En Vercel siempre nos encantó NodeJS y creamos casi todos los servicios de nuestro ecosistema sobre esta tecnología. Sin embargo, sentiamos la necesidad de tener una especificación formal para nuestra API pero nunca quisimos escribirla manualmente. Casi no hay soporte para generar automáticamente una especificación OpenAPI en el ecosistema de NodeJS, pero desde la amplia adopción de la tipificación estática, se ha hecho posible escribir generadores para este propósito.

En esta charla, comenzaremos explicando cómo evolucionaron los componentes internos de la API de Vercel desde 2017, desde un conjunto de servicios minimalistas de múltiples repositorios hasta un monorepositorio que se encuentra en un framework personalizado. Y a partir de ahí veremos cómo construimos una herramienta de análisis estático que nos permitió inferir una especificación a partir de la implementación de nuestras API y cómo la integramos usando Vercel en nuestro flujo de trabajo para recibir alertas sobre cambios en la API.

Sobre el speaker:

Javier Velasco es un ingeniero full-stack que lidera Ingeniería API en Vercel, la plataforma detrás de NextJS. Le apasiona la música y el software, y especialmente el OSS y el ecosistema React. En el pasado, creó React Toolbox, un kit de interfaz de usuario de diseño de materiales que alcanzó una gran popularidad y fue utilizado por compañías como Netflix o Paypal. También fue autor de otros proyectos OSS como React Tunnels o React CSS Themr. Actualmente se abrió paso en el backend y está enfocado en mejorar la experiencia del desarrollador dentro del equipo de Vercel.

Sobre Vercel:

Vercel es una plataforma en la nube para sitios estáticos y funciones sin servidor. Permite a los desarrolladores alojar sitios y servicios web que se despliegan instantáneamente, escalan automáticamente y no requieren supervisión, todo sin configuración.