Repolode
Enviar
instant-dev

instant-dev/api

Framework JavaScript para criar APIs web com segurança de tipos, gerar especificações OpenAPI a partir de comentários JSDoc e transmitir respostas de LLM via SSE.

Ver no GitHubSite
Estrelas
254
Forks
9
Issues abertas
2
Último commit
há 2 meses

O que é?

Instant API é um framework JavaScript para criar APIs web em que a verificação de tipos acontece na interface HTTP. Os desenvolvedores documentam uma função de endpoint exportada com um comentário no estilo JSDoc, e a validação e sanitização de parâmetros, além das verificações de resposta, são derivadas desses tipos, dispensando bibliotecas de validação de schema separadas. Uma especificação OpenAPI em JSON e YAML, junto com um JSON schema para chamadas de funções de LLM, é gerada automaticamente no caminho /.well-known/ do servidor.

Os endpoints mapeiam caminhos de arquivos em um diretório functions/ para rotas HTTP, e cada função GET, POST, PUT ou DELETE exportada trata o método correspondente. O framework também serve arquivos estáticos de um diretório www/, aceita corpos de requisição form-urlencoded, multipart e JSON, e define cabeçalhos CORS permissivos por padrão, com uma diretiva @origin para restringir o acesso.

Para integrações com IA e chat, os endpoints podem transmitir Server-Sent Events por meio do método context.stream() e de um schema @stream, além de retornar uma resposta 200 imediatamente enquanto continuam o processamento em segundo plano, o que é adequado para webhooks do Slack ou Discord. O projeto é distribuído no npm como @instant.dev/api e também é usado com a ferramenta de linha de comando instant.dev para configurar projetos, gerar endpoints e fazer deploy.

Recursos principais

  • 01Gera especificações OpenAPI em JSON e YAML a partir de comentários JSDoc.
  • 02Valida parâmetros e valores de retorno com base nos tipos, tamanhos e intervalos declarados.
  • 03Gera JSON schema para chamadas de funções de LLM.
  • 04Transmite respostas como text/event-stream usando @stream e context.stream().
  • 05Executa o processamento dos endpoints em segundo plano para responder imediatamente a webhooks.
  • 06Serve arquivos estáticos de um diretório www/ junto com as rotas da API.

Casos de uso

  • Criar uma API JSON cuja validação de requisições venha dos comentários das funções, em vez de uma biblioteca de schema separada.
  • Disponibilizar um endpoint baseado em LLM que transmita tokens para um cliente no navegador.
  • Criar um handler de webhook do Slack ou Discord que precise responder rapidamente e processar o trabalho em seguida.
  • Publicar uma especificação OpenAPI e um schema de chamadas de funções para um conjunto de endpoints existente.

Início rápido

  1. 1

    Instale globalmente as ferramentas de linha de comando do instant.dev

    npm i instant.dev -g
  2. 2

    Crie uma nova pasta para o projeto e acesse-a

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

    Inicialize o projeto

    instant init
  4. 4

    Inicie o servidor

    instant serve

Antes de usar

  • Para configurar tudo mais rapidamente, é necessário ter o Node.js e a CLI do instant.dev.
  • O README o descreve como uma versão inicial, então é provável que haja mudanças.

Em coleções

Frameworks de microsserviços e infraestrutura de serviços

Tópicos

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

Perguntas frequentes

O que é api?
Framework JavaScript para criar APIs web com segurança de tipos, gerar especificações OpenAPI a partir de comentários JSDoc e transmitir respostas de LLM via SSE. Instant API é um framework JavaScript para criar APIs web em que a verificação de tipos acontece na interface HTTP. Os desenvolvedores documentam uma função de endpoint exportada com um comentário no estilo JSDoc, e a validação e sanitização de parâmetros, além das verificações de resposta, são derivadas desses tipos, dispensando bibliotecas de validação de schema separadas. Uma especificação OpenAPI em JSON e YAML, junto com um JSON schema para chamadas de funções de LLM, é gerada automaticamente no caminho /.well-known/ do servidor.
api é gratuito? Qual é a licença?
api é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
api ainda é mantido?
Atualizado nos últimos 6 meses. O último commit de api foi em 14 de set. de 2026.
Para que posso usar api?
Criar uma API JSON cuja validação de requisições venha dos comentários das funções, em vez de uma biblioteca de schema separada. Disponibilizar um endpoint baseado em LLM que transmita tokens para um cliente no navegador. Criar um handler de webhook do Slack ou Discord que precise responder rapidamente e processar o trabalho em seguida. Publicar uma especificação OpenAPI e um schema de chamadas de funções para um conjunto de endpoints existente.
Como instalar api?
Instale globalmente as ferramentas de linha de comando do instant.dev: npm i instant.dev -g Crie uma nova pasta para o projeto e acesse-a: cd ~/projects && mkdir my-new-project && cd my-new-project Inicialize o projeto: instant init Inicie o servidor: instant serve
Onde consigo api?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/instant-dev/api

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados