instant-dev/api

어떤 프로젝트인가요?

핵심 기능

• 01JSDoc 주석에서 JSON 및 YAML 형식의 OpenAPI 사양을 생성합니다.
• 02선언된 타입과 크기, 범위를 기준으로 매개변수와 반환값을 검증합니다.
• 03LLM 함수 호출용 JSON 스키마를 생성합니다.
• 04@stream 및 context.stream()을 사용해 text/event-stream 형식으로 응답을 스트리밍합니다.
• 05웹훅에 즉시 응답할 수 있도록 엔드포인트 작업을 백그라운드에서 실행합니다.
• 06API 라우트와 함께 www/ 디렉터리의 정적 파일을 제공합니다.

활용 사례

• 별도의 스키마 라이브러리 대신 함수 주석을 바탕으로 요청을 검증하는 JSON API 구축
• LLM 기반 엔드포인트에서 브라우저 클라이언트로 토큰을 스트리밍
• 빠르게 응답한 뒤 작업을 처리해야 하는 Slack 또는 Discord 웹훅 핸들러 개발
• 기존 엔드포인트에 대한 OpenAPI 사양과 함수 호출 스키마 공개

빠른 시작

1. 1

   instant.dev 명령줄 도구를 전역으로 설치합니다

   npm i instant.dev -g
2. 2

   새 프로젝트 폴더를 만들고 해당 폴더로 이동합니다

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

   프로젝트를 초기화합니다

   instant init
4. 4

   서버를 시작합니다

   instant serve

사용 전 알아둘 점

• !가장 빠르게 설정하려면 Node.js와 instant.dev CLI가 필요합니다.
• !README에서 초기 릴리스라고 설명하므로 변경될 수 있습니다.

포함된 컬렉션

토픽

자주 묻는 질문

api은(는) 무엇인가요?

JSDoc 주석에서 OpenAPI 사양을 생성하고, LLM 응답용 SSE 스트리밍을 기본 제공하는 타입 안전 웹 API 구축 JavaScript 프레임워크입니다. Instant API는 HTTP 인터페이스에서 타입 검사를 수행하는 웹 API 구축용 JavaScript 프레임워크입니다. 개발자는 내보내기한 엔드포인트 함수에 JSDoc 스타일 주석으로 문서를 작성하며, 해당 타입을 바탕으로 매개변수 검증과 정제, 응답 검사가 이루어지므로 별도의 스키마 검증 라이브러리가 필요하지 않습니다. JSON 및 YAML 형식의 OpenAPI 사양과 LLM 함수 호출용 JSON 스키마는 서버의 /.well-known/ 경로에 자동으로 생성됩니다.

api은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

api은(는) MIT 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

api은(는) 아직 유지보수되고 있나요?

6개월 이내 업데이트. api의 마지막 커밋은 2026년 9월 14일입니다.

api은(는) 어디에 사용할 수 있나요?

별도의 스키마 라이브러리 대신 함수 주석을 바탕으로 요청을 검증하는 JSON API 구축 LLM 기반 엔드포인트에서 브라우저 클라이언트로 토큰을 스트리밍 빠르게 응답한 뒤 작업을 처리해야 하는 Slack 또는 Discord 웹훅 핸들러 개발 기존 엔드포인트에 대한 OpenAPI 사양과 함수 호출 스키마 공개

api는 어떻게 설치하나요?

instant.dev 명령줄 도구를 전역으로 설치합니다: npm i instant.dev -g 새 프로젝트 폴더를 만들고 해당 폴더로 이동합니다: cd ~/projects && mkdir my-new-project && cd my-new-project 프로젝트를 초기화합니다: instant init 서버를 시작합니다: instant serve

api은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/instant-dev/api