Repolode
Enviar
instant-dev

instant-dev/api

Framework de JavaScript para crear APIs web con seguridad de tipos, generar especificaciones OpenAPI a partir de comentarios JSDoc y transmitir respuestas de LLM mediante SSE.

Ver en GitHubSitio web
Estrellas
254
Forks
9
Issues abiertos
2
Último commit
hace 2 meses

¿Qué es?

Instant API es un framework de JavaScript para crear APIs web en las que la comprobación de tipos se realiza en la interfaz HTTP. Los desarrolladores documentan una función de endpoint exportada con un comentario de estilo JSDoc, y de esos tipos se derivan la validación y sanitización de parámetros, así como las comprobaciones de las respuestas, por lo que no se necesitan bibliotecas de validación de esquemas por separado. Se generan automáticamente una especificación OpenAPI en JSON y YAML y un esquema JSON para la invocación de funciones de LLM, en la ruta /.well-known/ del servidor.

Las rutas HTTP se corresponden con las rutas de archivo de un directorio functions/, y cada función GET, POST, PUT o DELETE exportada gestiona su método. El framework también sirve archivos estáticos desde un directorio www/, admite cuerpos de solicitud form-urlencoded, multipart y JSON, y establece encabezados CORS permisivos de forma predeterminada, con una directiva @origin para restringirlos.

Para integraciones de IA y chat, los endpoints pueden transmitir Server-Sent Events mediante el método context.stream() y un esquema @stream, y responder inmediatamente con un estado 200 mientras el trabajo continúa en segundo plano, algo adecuado para webhooks de Slack o Discord. El proyecto se distribuye en npm como @instant.dev/api y también se usa con la herramienta de línea de comandos instant.dev para configurar proyectos, generar endpoints y desplegarlos.

Funciones clave

  • 01Genera especificaciones OpenAPI en JSON y YAML a partir de comentarios JSDoc.
  • 02Valida parámetros y valores de retorno según los tipos, tamaños y rangos declarados.
  • 03Genera esquemas JSON para la invocación de funciones de LLM.
  • 04Transmite respuestas como text/event-stream mediante @stream y context.stream().
  • 05Ejecuta el trabajo de los endpoints en segundo plano para responder de inmediato a los webhooks.
  • 06Sirve archivos estáticos desde un directorio www/ junto con las rutas de la API.

Casos de uso

  • Crear una API JSON cuya validación de solicitudes se derive de los comentarios de las funciones, en lugar de usar una biblioteca de esquemas por separado.
  • Exponer un endpoint basado en un LLM que transmita tokens a un cliente de navegador.
  • Crear un controlador de webhooks de Slack o Discord que deba responder rápidamente y procesar el trabajo después.
  • Publicar una especificación OpenAPI y un esquema de invocación de funciones para un conjunto existente de endpoints.

Inicio rápido

  1. 1

    Instala globalmente las herramientas de línea de comandos de instant.dev

    npm i instant.dev -g
  2. 2

    Crea una nueva carpeta para el proyecto y accede a ella

    cd ~/projects && mkdir my-new-project && cd my-new-project
  3. 3

    Inicializa el proyecto

    instant init
  4. 4

    Inicia el servidor

    instant serve

Antes de usarlo

  • Para configurar todo más rápido, necesitas Node.js y la CLI de instant.dev.
  • El README lo describe como una versión inicial, así que es de esperar que haya cambios.

En colecciones

Frameworks de microservicios e infraestructura de servicios

Temas

#api#javascript#nodejs#openapi#server-sent-events#llm#webhooks#type-safety#api-gateway#bun

Preguntas frecuentes

¿Qué es api?
Framework de JavaScript para crear APIs web con seguridad de tipos, generar especificaciones OpenAPI a partir de comentarios JSDoc y transmitir respuestas de LLM mediante SSE. Instant API es un framework de JavaScript para crear APIs web en las que la comprobación de tipos se realiza en la interfaz HTTP. Los desarrolladores documentan una función de endpoint exportada con un comentario de estilo JSDoc, y de esos tipos se derivan la validación y sanitización de parámetros, así como las comprobaciones de las respuestas, por lo que no se necesitan bibliotecas de validación de esquemas por separado. Se generan automáticamente una especificación OpenAPI en JSON y YAML y un esquema JSON para la invocación de funciones de LLM, en la ruta /.well-known/ del servidor.
¿api es gratuito? ¿Qué licencia tiene?
api es open source bajo la licencia MIT. Revisa los términos de la licencia antes de usarlo en productos comerciales.
¿api sigue mantenido?
Actualizado en los últimos 6 meses. El último commit de api fue el 14 sept 2026.
¿Para qué puedo usar api?
Crear una API JSON cuya validación de solicitudes se derive de los comentarios de las funciones, en lugar de usar una biblioteca de esquemas por separado. Exponer un endpoint basado en un LLM que transmita tokens a un cliente de navegador. Crear un controlador de webhooks de Slack o Discord que deba responder rápidamente y procesar el trabajo después. Publicar una especificación OpenAPI y un esquema de invocación de funciones para un conjunto existente de endpoints.
¿Cómo se instala api?
Instala globalmente las herramientas de línea de comandos de instant.dev: npm i instant.dev -g Crea una nueva carpeta para el proyecto y accede a ella: cd ~/projects && mkdir my-new-project && cd my-new-project Inicializa el proyecto: instant init Inicia el servidor: instant serve
¿Dónde consigo api?
El código fuente y las instrucciones de instalación están en GitHub: https://github.com/instant-dev/api

Resumen generado por IA a partir del README del proyecto. Las estadísticas de GitHub se actualizan a diario.

Proyectos relacionados