Unduhan restwave - Unduh Kode Sumber restwave

restwave

Kategori lainnya

1.0.0

Unduh

RESTWAVE - Membangun Api Restful yang kuat menjadi mudah

Selamat datang di RestWave, kerangka kerja aplikasi web backend yang kuat dan kaya fitur yang dirancang khusus untuk membangun API REST dengan mudah dengan Node.js. Dibangun di atas server TCP menggunakan Modul Net Node.js, RestWave Empowers Developer untuk membuat titik akhir API berkinerja tinggi dengan mudah.

Fitur

Dukungan CORS built-in : RESTWAVE menawarkan penanganan CORS built-in (Cross-Origin Resource Sharing), menghilangkan kebutuhan akan perpustakaan eksternal seperti CORS di Express. Secara otomatis menangani header dan opsi yang diperlukan, menyederhanakan manajemen permintaan lintas asal dan menghemat waktu selama pengembangan API. RESTWAVE memastikan kontrol akses silang-asal yang mulus untuk API Anda tanpa kerumitan konfigurasi tambahan.
Pengembangan API yang mudah : RestWave menyederhanakan proses menciptakan API REST dengan memberikan kerangka kerja yang terstruktur dengan baik yang menangani tugas-tugas umum, memungkinkan Anda untuk fokus membangun logika aplikasi inti Anda.
Kinerja Tinggi : Memanfaatkan kekuatan server TCP, RESTWAVE memastikan kinerja dan skalabilitas yang luar biasa, memungkinkan API Anda untuk menangani sejumlah besar koneksi simultan dan permintaan secara efisien.
Routing Fleksibel : Dengan sistem perutean fleksibel RestWave, Anda dapat dengan mudah mendefinisikan rute API Anda, termasuk dukungan untuk parameter dinamis, parameter kueri, middleware, dan banyak lagi. Ini menyediakan antarmuka yang bersih dan intuitif untuk mendefinisikan titik akhir dan menangani metode HTTP.
Dukungan Middleware : RESTWAVE menawarkan dukungan middleware untuk membantu Anda menangani otentikasi, validasi permintaan, penanganan kesalahan, dan masalah lintas sekelompok lainnya. Mudah mencolokkan fungsi middleware Anda untuk menambahkan logika khusus pada berbagai tahap siklus hidup-respons permintaan.
Extensibility : RestWave dirancang agar dapat diperluas, memungkinkan Anda untuk mengintegrasikan plugin tambahan, modul, atau komponen khusus Anda sendiri dengan mulus. Menyesuaikan kerangka kerja dengan kebutuhan spesifik Anda sambil memanfaatkan fungsionalitas kuat yang ada.

Memulai

Ikuti langkah -langkah ini untuk mengatur dengan cepat dan mulai menggunakan RestWave untuk membangun API Anda yang REST:

Prasyarat

Sebelum memulai, pastikan Anda menginstal berikut:

Node.js (versi 12 atau lebih tinggi)
NPM (Node Package Manager)

Instalasi

 npm install restwave

Membuat API Anda Sendiri

 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 } ....` ) ;
} ) ;

Meminta badan

Untuk mengakses request body kami Prodvide data Param.
- req.data

Metode respons

Objek RES di RestWave menyediakan beberapa metode untuk mengirim tanggapan kembali ke klien. Berikut adalah metode yang didukung:

res.json (data)
- Description : Mengirim tanggapan JSON ke klien.
- Accepts : objek JavaScript atau string dalam format JSON.
- Example :
```
 res . json ( { message : "Success" , data : { name : "John" , age : 30 } } ) ;
```
res.send (data)
- Description : Mengirimkan tanggapan umum ke klien.
- Accepts : String atau berbagai jenis data, termasuk XML, SVG, HTML, format berbasis teks (misalnya, CSS, SCG, teks biasa), dll. Data harus dalam format string.
- Example :
```
 res . send ( "<h1>Welcome to my website!</h1>" ) ;
```
res.sendfile (jalur)
- Description : Mengirim file sebagai respons ke klien.
- Accepts : Pathname dari file yang akan dikirim. Jenis file yang didukung termasuk CSS, PNG, JPEG/JPG, HTML, GIF, MP4, JS, JSON, PDF, dll.
- Example :
```
 res . sendFile ( "/path/to/myfile.html" ) ;
```

Penting untuk dicatat bahwa metode Res

Penanganan kesalahan

Kami juga menyediakan mekanisme penanganan kesalahan khusus di mana Anda dapat menangani kesalahan khusus,

 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 ) ;

Berkontribusi

Kami menyambut kontribusi dari komunitas pengembang untuk membuat Restwave lebih baik. Untuk berkontribusi, silakan tinjau pedoman kontribusi kami di sini. Apakah Anda ingin melaporkan bug, mengusulkan fitur baru, atau mengirimkan permintaan tarik, keterlibatan Anda sangat dihargai.

Lisensi

RestWave adalah open-source dan dirilis di bawah lisensi MIT. Jangan ragu untuk menggunakan, memodifikasi, dan mendistribusikannya sesuai persyaratan lisensi.