Descarga restwave - Descargar el código fuente restwave

restwave

Otras categorias

1.0.0

Descargar

RestWave - Construyendo poderosas API RESTful Hechos fáciles

Bienvenido a RestWave, un marco de aplicaciones web de backend robusto y rico en funciones diseñado específicamente para construir API RESTful sin esfuerzo con Node.js. Construido en el servidor TCP utilizando el módulo de red Node.js, RestWave permite a los desarrolladores crear puntos finales de API de alto rendimiento con facilidad.

Características

Soporte de CORS incorporado : RestWave ofrece manejo CORS (intercambio de recursos de origen cruzado), eliminando la necesidad de una biblioteca externa como Cors en Express. Maneja automáticamente los encabezados y opciones necesarios, simplificando la gestión de solicitudes de origen cruzado y ahorrar tiempo durante el desarrollo de API. RestWave garantiza un control de acceso de origen cruzado sin problemas para sus API sin la molestia de la configuración adicional.
Desarrollo de API sin esfuerzo : RestWave simplifica el proceso de crear API RESTful al proporcionar un marco bien estructurado que se encarga de las tareas comunes, lo que le permite concentrarse en construir su lógica de aplicación principal.
Alto rendimiento : aprovechar la potencia del servidor TCP, RESTWAVE garantiza un rendimiento y escalabilidad excepcionales, lo que permite que sus API manejen una gran cantidad de conexiones y solicitudes simultáneas de manera eficiente.
Enrutamiento flexible : con el sistema de enrutamiento flexible de Restwave, puede definir fácilmente sus rutas API, incluido el soporte para parámetros dinámicos, parámetros de consulta, middleware y más. Proporciona una interfaz limpia e intuitiva para definir puntos finales y manejar métodos HTTP.
Soporte de middleware : RestWave ofrece soporte de middleware para ayudarlo a manejar la autenticación, la validación de solicitud, el manejo de errores y otras preocupaciones transversales. Conecte fácilmente sus funciones de middleware para agregar una lógica personalizada en varias etapas del ciclo de vida-respuesta de solicitud.
Extensibilidad : RestWave está diseñado para ser extensible, lo que le permite integrar complementos adicionales, módulos o sus propios componentes personalizados sin problemas. Adapte el marco a sus necesidades específicas mientras aprovecha la funcionalidad poderosa existente.

Empezando

Siga estos pasos para configurar rápidamente y comenzar a usar RestWave para construir sus API RESTFUL:

Requisitos previos

Antes de comenzar, asegúrese de tener lo siguiente instalado:

Node.js (versión 12 o superior)
NPM (Administrador de paquetes de nodo)

Instalación

 npm install restwave

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

Cuerpo de solicitud

Para acceder request body produje el parámetro data .
- req.data

Métodos de respuesta

El objeto RES en RestWave proporciona varios métodos para enviar respuestas al cliente. Aquí están los métodos compatibles:

res.json (datos)
- Description : Envía una respuesta JSON al cliente.
- Accepts : un objeto JavaScript o una cadena en formato JSON.
- Example :
```
 res . json ( { message : "Success" , data : { name : "John" , age : 30 } } ) ;
```
res.send (datos)
- Description : Envía una respuesta general al cliente.
- Accepts : una cadena o varios tipos de datos, incluidos XML, SVG, HTML, formatos basados en texto (por ejemplo, CSS, SCG, texto plano), etc. Los datos deben estar en formato de cadena.
- Example :
```
 res . send ( "<h1>Welcome to my website!</h1>" ) ;
```
res.sendfile (ruta)
- Description : Envía un archivo como respuesta al cliente.
- Accepts : El nombre de ruta de un archivo que se enviará. Los tipos de archivos compatibles incluyen CSS, PNG, JPEG/JPG, HTML, GIF, MP4, JS, JSON, PDF, etc.
- Example :
```
 res . sendFile ( "/path/to/myfile.html" ) ;
```

Es importante tener en cuenta que los métodos res.json () y res.send () establecen automáticamente el encabezado de tipo de contenido apropiado en función de los datos que se envían, mientras que res.sendFile () se basa en la extensión del archivo para determinar el tipo de contenido.

Manejo de errores

También proporcionamos un mecanismo de manejo de errores personalizados donde puede manejar errores personalizados como,

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

Que contribuye

Damos la bienvenida a las contribuciones de la comunidad de desarrolladores para mejorar aún más RESTWAVE. Para contribuir, revise nuestras pautas de contribución aquí. Ya sea que desee informar un error, proponer nuevas funciones o enviar solicitudes de extracción, su participación es muy apreciada.