tyoi-server

日本語 | English

Express をベースにした、ローカル開発向けの API・静的ファイルサーバーフレームワークです。CLI から用途別テンプレートを作成でき、HTTP API、WebSocket、静的ファイル配信、LAN 公開に対応しています。

v1.x では公開 TypeScript API と文書化済みの通信仕様に破壊的変更を行いません。後方互換な追加と修正は行われる場合があります。次の破壊的変更は v2.0.0 で行います。

クイックスタート

Node.js 20.14 以上が必要です。

npm install @donneko/tyoi-server
npx tyoi init my-app --template basic-js
npm install
npm run dev

起動後、表示された Local URL をブラウザーで開きます。詳しくはクイックスタートを参照してください。

用途別ドキュメント

• API の使用例 / API の仕様
• CLI の使用例 / CLI の仕様
• 設定の使用例 / 設定の仕様
• テンプレートの使用例 / テンプレートの仕様
• できることの例 / 機能と制約
• 静的ファイル配信の使用例 / 配信仕様
• v1 移行ガイド
• 自動生成 API リファレンス

最小のプログラム例

import { tyoi } from "@donneko/tyoi-server";

const app = tyoi({
    root: import.meta.dirname,
    public: "../public",
    api: "/api",
    port: 3000,
});

app.get("/hello", () => ({ message: "Hello Tyoi!" }));

await app.start();

この API はデフォルト設定では GET /api/hello で呼び出せます。

gui: true を設定すると、同じサーバーの /__tyoi/ で概要・状態・最新ログを確認できます。既定ではローカル接続だけに限定されます。設定例とLAN公開時の注意事項は組み込み管理GUIを参照してください。

ライセンス

MIT