ts rest

TS-Rest

可逐步採用的類似RPC的客戶端和服務器幫助者，以獲得神奇的端到一端的鍵入體驗？

加入我們的不和諧，反饋和討論！

介紹

TS-REST提供了一種簡單的方法來定義API合同，您的應用程序可以既可以消耗又可以實施，從而使您無需麻煩或代碼生成而端到端類型的安全性。

特徵

• 端到端類型安全？
• 類似RPC的客戶端API⚡️
• 小捆尺寸？
• 沒有代碼生成？ ‍♀️
• ZOD支持運行時驗證
• 完整可選的OpenAPI集成

開始閱讀官方Quickstart指南？

超級簡單的例子

輕鬆定義您的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!
} ) ; 

Quickstart

創建合同，在服務器上實現它，然後在您的客戶端中消耗它。逐步採用，與您的團隊進行試用，然後更快地運輸。

開始閱讀官方Quickstart指南？

貢獻者

非常感謝所有這些出色的人（表情符號鑰匙），他們幫助使TS-Rest成為可能：

Youssef Gaber ？配x	根據赫曼森	GrégoryHoullier	邁克爾·安吉洛	Pieter Venter	Rifaldhi AW	喬納森·懷特
馬克斯·布羅斯納漢（Max Brosnahan） ？	奧利弗·巴特勒 ？ ？ ？	阿德里安·巴里斯基（Adrian Barylski） 配x	Neil A. Dobson	埃里克（Eric）做	本 配x	LW ？
安德魯萬斯

星曆史

自2022年我們的第一次提交以來，我們一直在穩步增長。我們為我們的進步感到自豪，我們對未來感到興奮。

加入我們的不和諧，反饋和討論！