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

restwave

หมวดหมู่อื่นๆ

1.0.0

ดาวน์โหลด

RESTWAVE - การสร้าง API ที่มีประสิทธิภาพทำให้ง่ายขึ้น

ยินดีต้อนรับสู่ Restwave กรอบแอปพลิเคชันเว็บแบ็คเอนด์ที่แข็งแกร่งและมีคุณสมบัติที่ออกแบบมาโดยเฉพาะสำหรับการสร้าง APIs ที่เหลือด้วย Node.js. สร้างขึ้นบนเซิร์ฟเวอร์ TCP โดยใช้โมดูล NODE.JS NET, RESTWAVE ให้อำนาจแก่นักพัฒนาเพื่อสร้างจุดสิ้นสุด API ที่มีประสิทธิภาพสูงได้อย่างง่ายดาย

คุณสมบัติ

การสนับสนุน CORS ในตัว : RESTWAVE เสนอการจัดการ CORS ในตัว มันจัดการส่วนหัวและตัวเลือกที่จำเป็นโดยอัตโนมัติทำให้การจัดการคำขอข้ามแหล่งกำเนิดง่ายขึ้นและประหยัดเวลาในระหว่างการพัฒนา API RESTWAVE ทำให้มั่นใจได้ว่าการควบคุมการเข้าถึงข้ามต้นที่ไร้รอยต่อสำหรับ API ของคุณโดยไม่ต้องยุ่งยากในการกำหนดค่าเพิ่มเติม
การพัฒนา API อย่างง่ายดาย : Restwave ทำให้กระบวนการสร้าง APIs ที่น่าประทับใจง่ายขึ้นโดยการจัดหากรอบการทำงานที่มีโครงสร้างที่ดีซึ่งดูแลงานทั่วไปช่วยให้คุณสามารถมุ่งเน้นไปที่การสร้างตรรกะแอปพลิเคชันหลักของคุณ
ประสิทธิภาพสูง : การใช้ประโยชน์จากพลังของเซิร์ฟเวอร์ TCP, RESTWAVE ทำให้มั่นใจได้ว่าประสิทธิภาพและความสามารถในการปรับขนาดที่ยอดเยี่ยมช่วยให้ API ของคุณสามารถจัดการการเชื่อมต่อและคำขอได้อย่างมีประสิทธิภาพจำนวนมาก
การกำหนดเส้นทางที่ยืดหยุ่น : ด้วยระบบการกำหนดเส้นทางที่ยืดหยุ่นของ Restwave คุณสามารถกำหนดเส้นทาง API ของคุณได้อย่างง่ายดายรวมถึงการรองรับพารามิเตอร์แบบไดนามิกพารามิเตอร์การสืบค้นมิดเดิลแวร์และอื่น ๆ มันให้อินเทอร์เฟซที่สะอาดและใช้งานง่ายสำหรับการกำหนดจุดสิ้นสุดและการจัดการวิธี HTTP
การสนับสนุนมิดเดิลแวร์ : RESTWAVE เสนอการสนับสนุนมิดเดิลแวร์เพื่อช่วยคุณจัดการการรับรองความถูกต้องการตรวจสอบความถูกต้องการจัดการข้อผิดพลาดและข้อกังวลข้ามการตัดอื่น ๆ เสียบฟังก์ชั่นมิดเดิลแวร์ของคุณอย่างง่ายดายเพื่อเพิ่มตรรกะที่กำหนดเองในขั้นตอนต่าง ๆ ของวงจรชีวิตตอบสนองการร้องขอ
Extensibility : Restwave ได้รับการออกแบบให้สามารถขยายได้ช่วยให้คุณสามารถรวมปลั๊กอินเพิ่มเติมโมดูลหรือส่วนประกอบที่กำหนดเองของคุณเองได้อย่างราบรื่น ปรับแต่งเฟรมเวิร์กตามความต้องการเฉพาะของคุณในขณะที่ใช้ประโยชน์จากฟังก์ชั่นที่ทรงพลังที่มีอยู่

เริ่มต้น

ทำตามขั้นตอนเหล่านี้เพื่อตั้งค่าอย่างรวดเร็วและเริ่มใช้ Restwave เพื่อสร้าง APIs ที่เหลือของคุณ:

ข้อกำหนดเบื้องต้น

ก่อนเริ่มต้นใช้งานตรวจสอบให้แน่ใจว่าคุณติดตั้งดังต่อไปนี้:

node.js (เวอร์ชัน 12 หรือสูงกว่า)
NPM (Node Package Manager)

การติดตั้ง

 npm install restwave

การสร้าง API ของคุณเอง

 import RestWave from "restwave" ;
const app = new RestWave ( ) ;

const PORT = 9000 ;

app . get ( ( req , res ) => {
	res . send ( "This is my API endpoint." , 200 ) ;
} ) ;

app . listen ( PORT , ( ) => {
	cosnole . log ( `Listening to ${ PORT } ....` ) ;
} ) ;

ขอร่าง

ในการเข้าถึง request body เรา prodvide data param
- req.data

วิธีการตอบสนอง

วัตถุ RES ใน Restwave มีวิธีการหลายวิธีในการส่งคำตอบกลับไปยังลูกค้า นี่คือวิธีการที่รองรับ:

res.json (ข้อมูล)
- Description : ส่งการตอบกลับ JSON ไปยังลูกค้า
- Accepts : วัตถุ JavaScript หรือสตริงในรูปแบบ JSON
- Example :
```
 res . json ( { message : "Success" , data : { name : "John" , age : 30 } } ) ;
```
Res.Send (ข้อมูล)
- Description : ส่งการตอบกลับทั่วไปไปยังลูกค้า
- Accepts : สตริงหรือข้อมูลประเภทต่าง ๆ รวมถึง XML, SVG, HTML, รูปแบบข้อความที่ใช้ข้อความ (เช่น CSS, SCG, ข้อความธรรมดา) ฯลฯ ข้อมูลควรอยู่ในรูปแบบสตริง
- Example :
```
 res . send ( "<h1>Welcome to my website!</h1>" ) ;
```
Res.SendFile (เส้นทาง)
- Description : ส่งไฟล์เป็นการตอบกลับไปยังไคลเอนต์
- Accepts : ชื่อพา ธ ของไฟล์ที่จะส่ง ประเภทไฟล์ที่รองรับ ได้แก่ CSS, PNG, JPEG/JPG, HTML, GIF, MP4, JS, JSON, PDF ฯลฯ
- Example :
```
 res . sendFile ( "/path/to/myfile.html" ) ;
```

เป็นสิ่งสำคัญที่จะต้องทราบว่าเมธอด res.json () และ res.send () ตั้งค่าส่วนหัวประเภทเนื้อหาที่เหมาะสมโดยอัตโนมัติตามข้อมูลที่ถูกส่งในขณะที่ Res.sendFile () ขึ้นอยู่กับการขยายไฟล์เพื่อกำหนดประเภทเนื้อหา

การจัดการข้อผิดพลาด

นอกจากนี้เรายังมีกลไกการจัดการข้อผิดพลาดที่กำหนดเองซึ่งคุณสามารถจัดการกับข้อผิดพลาดที่กำหนดเองเช่น

 class AppError extends Error {
  constructor ( payload , statusCode ) {
    const data = JSON . stringify ( payload ) ;
    super ( data ) ;
    this . statusCode = statusCode ;
    this . payload = payload ;
    this . status = statusCode >= 500 ? "error" : "fail" ;
  }
}

 const errorController = async ( err , req , res , next ) => {
  res . json (
    {
      status : err . status ,
      payload : err . payload ,
    } ,
    err . statusCode
  ) ;
} ;

   app . use ( errorController ) ;

การบริจาค

เรายินดีต้อนรับการมีส่วนร่วมจากชุมชนนักพัฒนาเพื่อให้การพักผ่อนดียิ่งขึ้น หากต้องการมีส่วนร่วมโปรดตรวจสอบแนวทางการบริจาคของเราที่นี่ ไม่ว่าคุณต้องการรายงานข้อผิดพลาดเสนอคุณสมบัติใหม่หรือส่งคำขอดึงการมีส่วนร่วมของคุณจะได้รับการชื่นชมอย่างมาก