Téléchargement restwave - Téléchargement du code source de restwave

restwave

Autres catégories

1.0.0

Télécharger

Restwave - Construire de puissantes API RESTFULES Facaté

Bienvenue à Restwave, un cadre d'application Web backend robuste et riche en fonctionnalités spécialement conçu pour construire sans effort des API RESTful avec Node.js. Construit sur le serveur TCP à l'aide du module NET Node.js, Restwave permet aux développeurs de créer facilement des points de terminaison API à haute performance.

Caractéristiques

Prise en charge des COR intégrée : Restwave propose une maniabilité CORS (partage de ressources croisées), éliminant le besoin d'une bibliothèque externe comme CORS dans Express. Il gère automatiquement les en-têtes et les options nécessaires, simplifiant la gestion des demandes croisées et de l'heure de l'économie pendant le développement de l'API. Restwave assure un contrôle d'accès croisé sans couture pour vos API sans les tracas d'une configuration supplémentaire.
Développement des API sans effort : RestWave simplifie le processus de création d'API RESTful en fournissant un cadre bien structuré qui s'occupe des tâches courantes, vous permettant de vous concentrer sur la création de votre logique d'application de base.
Haute performance : tirant parti de la puissance du serveur TCP, Restwave garantit des performances et une évolutivité exceptionnelles, permettant à vos API de gérer efficacement un grand nombre de connexions et de demandes simultanées.
Routage flexible : avec le système de routage flexible de Restwave, vous pouvez facilement définir vos itinéraires API, y compris la prise en charge des paramètres dynamiques, les paramètres de requête, le middleware, etc. Il fournit une interface propre et intuitive pour définir des points de terminaison et la gestion des méthodes HTTP.
Prise en charge du middleware : Restwave offre une prise en charge du middleware pour vous aider à gérer l'authentification, la validation des demandes, la gestion des erreurs et d'autres préoccupations croisées. Branchez facilement vos fonctions de middleware pour ajouter une logique personnalisée à différentes étapes du cycle de vie de demande de réponse.
Extensibilité : Restwave est conçu pour être extensible, vous permettant d'intégrer des plugins, des modules supplémentaires ou vos propres composants personnalisés de manière transparente. Adaptez le cadre à vos besoins spécifiques tout en tirant parti des fonctionnalités puissantes existantes.

Commencer

Suivez ces étapes pour configurer rapidement et commencez à utiliser RestWave pour construire vos API RESTFULS:

Condition préalable

Avant de commencer, assurez-vous que vous avez installé les suivants:

Node.js (version 12 ou supérieure)
NPM (gestionnaire de packages de nœuds)

Installation

 npm install restwave

Créer votre propre 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 } ....` ) ;
} ) ;

Demander un corps

Afin d'accéder request body nous prodvinons data param.
- req.data

Méthodes de réponse

L'objet Res dans Restwave fournit plusieurs méthodes pour renvoyer les réponses au client. Voici les méthodes prises en charge:

res.json (données)
- Description : Envoie une réponse JSON au client.
- Accepts : un objet JavaScript ou une chaîne au format JSON.
- Example :
```
 res . json ( { message : "Success" , data : { name : "John" , age : 30 } } ) ;
```
res.send (données)
- Description : envoie une réponse générale au client.
- Accepts : une chaîne ou différents types de données, y compris XML, SVG, HTML, formats textuels (par exemple, CSS, SCG, texte brut), etc. Les données doivent être au format de chaîne.
- Example :
```
 res . send ( "<h1>Welcome to my website!</h1>" ) ;
```
res.sendfile (chemin)
- Description : envoie un fichier comme réponse au client.
- Accepts : le chemin d'accès d'un fichier à envoyer. Les types de fichiers pris en charge incluent CSS, PNG, JPEG / JPG, HTML, GIF, MP4, JS, JSON, PDF, etc.
- Example :
```
 res . sendFile ( "/path/to/myfile.html" ) ;
```

Il est important de noter que les méthodes res.json () et res.send () définissent automatiquement l'en-tête de type contenu approprié en fonction des données envoyées, tandis que Res.SendFile () s'appuie sur l'extension de fichier pour déterminer le type de contenu.

Gestion des erreurs

Nous fournissons également un mécanisme de gestion des erreurs personnalisé où vous pouvez gérer des erreurs personnalisées comme,

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

Contributif

Nous accueillons les contributions de la communauté des développeurs pour rendre les ondes de repos encore meilleures. Pour contribuer, veuillez consulter nos directives de contribution ici. Que vous souhaitiez signaler un bogue, proposer de nouvelles fonctionnalités ou soumettre des demandes de traction, votre implication est très appréciée.

Licence

Restwave est open-source et libéré sous la licence du MIT. N'hésitez pas à l'utiliser, à le modifier et à le distribuer conformément aux termes de la licence.