ts restダウンロードts restソースコードのダウンロード

ts rest

AI ソースコード

v3.51.0

ダウンロード

TS-REST

魔法のエンドツーエンドの型型エクスペリエンスのための徐々に採用可能なRPCのようなクライアントとサーバーヘルパー？

助け、フィードバック、ディスカッションのためにDiscordに参加してください！

導入

TS-Restは、APIの契約を定義する簡単な方法を提供します。APIは、アプリケーションによって消費および実装されることができ、手間やコード生成なしでエンドツーエンドタイプの安全性を提供します。

特徴

エンドツーエンドのタイプの安全性？
RPCのようなクライアントサイドAPI⚡️
小さなバンドルサイズ？
コード生成はありませんか？
ランタイム検証のZODサポート
完全なオプションのOpenAPI統合

公式のクイックスタートガイドを読み始めますか？

超単純な例

共有されたどこかでAPI契約を簡単に定義できます

 const contract = c . router ( {
  getPosts : {
    method : 'GET' ,
    path : '/posts' ,
    query : z . object ( {
      skip : z . number ( ) ,
      take : z . number ( ) ,
    } ) , // <-- Zod schema
    responses : {
      200 : c . type < Post [ ] > ( ) , // <-- OR normal TS types
    } ,
    headers : z . object ( {
      'x-pagination-page' : z . coerce . number ( ) . optional ( ) ,
    } ) ,
  } ,
} ) ;

タイプセーフルーターを使用して、サーバー上の契約を履行します。

 const router = s . router ( contract , {
  getPosts : async ( { params : { id } } ) => {
    return {
      status : 200 ,
      body : prisma . post . findUnique ( { where : { id } } ) ,
    } ;
  } ,
} ) ;

RPCのようなインターフェイスでクライアントのAPIを消費します。

 const result = await client . getPosts ( {
  headers : { 'x-pagination-page' : 1 } ,
  query : { skip : 0 , take : 10 } ,
  // ^-- Fully typed!
} ) ;

クイックスタート

契約を作成し、サーバーにそれを実装し、クライアントで消費します。漸進的に採用し、チームと一緒に試してから、より速く出荷します。

公式のクイックスタートガイドを読み始めますか？

貢献者

これらの素晴らしい人々（絵文字キー）のすべてに大いに感謝します。

_{youssef gaber} ？ショ和	_{ハーマンソンごと}	_{グレゴリー・ホーリエ}	_{マイケル・アンジェロ}	_{ピーターベンター}	_{Rifaldhi AW}	_{ジョナサン・ホワイト}
_{マックス・ブロスナハン} ？	_{オリバーバトラー} ？？？	_{エイドリアン・バリルスキー} ショ和	_{ニール・A・ドブソン}	_{エリックはします}	_ベンショ和	_LW ？
_{アンドリュー・ヴァンス}