Skip to content
@inkanjs

Inkan

An API server for Node where the docs can't lie.

inkan

An API framework for Node where the docs can't lie.

Docs · Hanko · Benchmarks · Changelog

An inkan (印鑑) is the seal a Japanese contract gets stamped with. Here every route carries one, written once: inkan checks what comes in, types your handler, trims what goes out, writes OpenAPI, serves the docs, runs your examples as tests and hands your frontend a typed client. The core has no dependencies.

import { inkan, t } from "@vxnsin/inkan";

inkan()
  .get("/hello/:name", { params: t.object({ name: t.string() }) }, ({ params }) => ({ hello: params.name }))
  .listen({ port: 3000 }); // docs on /docs, a live inspector on /_inkan

Repositories

inkan the framework: routes and contracts, docs, inkan check, jobs, websockets, a typed client
middleware official plugins: auth, session, secure-headers, etag, idempotency, proxy, circuit-breaker, otel, and stores for Redis, Postgres, MongoDB and MySQL
integrations inkan where you already are: Next.js, Vite, TanStack Query, uWebSockets.js
inkan.dev the website and docs, itself an inkan app

Everything that plugs into inkan, official or not, is listed on Hanko. Publish a package with the npm keyword inkan-plugin and it shows up there by itself.

Start

npx @vxnsin/inkan learn                      # twelve quests in your terminal, offline
npx @vxnsin/inkan examples                   # six explained projects to start from
npx @vxnsin/inkan create plugin inkan-quota  # a plugin package with tests, ready to publish

Questions, bugs and ideas go into issues, and pull requests are welcome. Since 0.8 the API is stable: renames keep working with a warning for at least two releases. MIT licensed.

Popular repositories Loading

  1. inkan inkan Public

    An API server for Node where the docs can't lie: one contract per route gives you validation, types, OpenAPI, docs and tests.

    TypeScript 1 2

  2. .github .github Public

    The inkanjs profile and shared community files

  3. integrations integrations Public

    inkan where you already are: Next.js, Vite, TanStack Query, uWebSockets.js

    TypeScript

  4. inkan.dev inkan.dev Public

    inkan.dev: the website and docs of inkan, the API framework for Node where the docs can't lie

    MDX

  5. middleware middleware Public

    More middleware for inkan: auth, sessions, secure headers, ETags, idempotency, a proxy, circuit breakers and tracing. One package each.

    TypeScript

Repositories

Showing 5 of 5 repositories

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…