ดาวน์โหลด ts rest - ดาวน์โหลดซอร์สโค้ด ts rest

ts rest

โค้ดแหล่งที่มา AI

v3.51.0

ดาวน์โหลด

TS-Rest

ไคลเอนต์ RPC และผู้ช่วยเซิร์ฟเวอร์ที่นำมาใช้ร่วมกันได้เพิ่มขึ้นสำหรับประสบการณ์การพิมพ์ที่มีมนต์ขลัง

เข้าร่วมกับเราใน Discord เพื่อขอความช่วยเหลือข้อเสนอแนะและการอภิปราย!

การแนะนำ

TS-REST เสนอวิธีง่ายๆในการกำหนดสัญญาสำหรับ API ของคุณซึ่งสามารถใช้งานได้และนำไปใช้โดยแอปพลิเคชันของคุณทำให้คุณจบประเภทความปลอดภัยโดยไม่ต้องยุ่งยากหรือสร้างรหัส

คุณสมบัติ

ความปลอดภัยประเภทแบบ end-to-end?
API ด้านไคลเอ็นต์ RPC ที่มีลักษณะคล้าย RPC ⚡
ขนาดมัดขนาดเล็ก?
ไม่มีการสร้างรหัส? ‍♀
การสนับสนุน 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 } } ) ,
    } ;
  } ,
} ) ;

กิน API บนไคลเอนต์ด้วยอินเทอร์เฟซคล้าย RPC:

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

เร็ว

สร้างสัญญานำไปใช้กับเซิร์ฟเวอร์ของคุณจากนั้นใช้ในไคลเอนต์ของคุณ นำไปใช้เพิ่มขึ้นทดลองใช้กับทีมของคุณจากนั้นจัดส่งเร็วขึ้น

เริ่มอ่านคู่มือ QuickStart อย่างเป็นทางการ?

ผู้มีส่วนร่วม

ขอบคุณมากสำหรับผู้คนที่ยอดเยี่ยมเหล่านี้ (คีย์อีโมจิ) ที่ช่วยให้ TS-Rest เป็นไปได้:

_{Youssef Gaber} -	_{ต่อเฮอร์แมนสัน}	_{Grégory Houllier}	_{Michael Angelo}	_{Pieter Venter}	_{Rifaldhi Aw}	_{โจนาธานไวท์}
_{Max Brosnahan} -	_{โอลิเวอร์บัตเลอร์} - - -	_{Adrian Barylski}	_{Neil A. Dobson}	_{Eric ทำ}	_เบ็น	_LW -
_{Andrew Vance}