restwave

ONUSE

Bem-vindo ao Restwave, uma estrutura de aplicativos de back-end rica e rica em recursos, projetada especificamente para construir sem esforço APIs RESTful com Node.JS. Construído sobre o servidor TCP usando o módulo NET Node.js, o Rest-owave capacita os desenvolvedores para criar pontos de extremidade da API de alto desempenho com facilidade.

Características

• Suporte aos CORs embutidos : o Restwave oferece manuseio de CORS (Compartilhamento de Recursos Cross-Origin), eliminando a necessidade de uma biblioteca externa como o CORS no Express. Ele lida automaticamente os cabeçalhos e opções necessários, simplificando o gerenciamento de solicitações de origem cruzada e economizando tempo durante o desenvolvimento da API. A onda Rest garante o controle de acesso cruzado da origem cruzada para suas APIs sem o incômodo da configuração adicional.

• Desenvolvimento de API sem esforço : o onda de restaurante simplifica o processo de criação de APIs RESTful, fornecendo uma estrutura bem estruturada que cuida de tarefas comuns, permitindo que você se concentre na criação de sua lógica principal do aplicativo.

• Alto desempenho : alavancando a potência do servidor TCP, a onda restante garante desempenho e escalabilidade excepcionais, permitindo que suas APIs lidem com um grande número de conexões simultâneas e solicitações com eficiência.

• Roteamento flexível : com o sistema de roteamento flexível do Restwave, você pode definir facilmente suas rotas de API, incluindo suporte para parâmetros dinâmicos, parâmetros de consulta, middleware e muito mais. Ele fornece uma interface limpa e intuitiva para definir pontos de extremidade e manusear métodos HTTP.

• Suporte ao Middleware : o Restwave oferece suporte ao middleware para ajudá-lo a lidar com autenticação, validação de solicitação, manipulação de erros e outras preocupações cruzadas. Conecte facilmente suas funções de middleware para adicionar lógica personalizada em vários estágios do ciclo de vida de solicitação-resposta.

• Extensibilidade : a onda de restrição foi projetada para ser extensível, permitindo que você integre plugins, módulos ou seus próprios componentes personalizados. Adapte a estrutura às suas necessidades específicas e aproveitando a funcionalidade poderosa existente.

Começando

Siga estas etapas para configurar rapidamente e comece a usar owave Rest para construir suas APIs RESTful:

Pré -requisitos

Antes de começar, certifique -se de ter o seguinte instalado:

• Node.js (versão 12 ou superior)
• NPM (Gerenciador de pacotes de nó)

Instalação

 npm install restwave

Criando sua própria 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 } ....` ) ;
} ) ;

Solicitar corpo

1. Para acessar request body Produce data Param.

   • req.data

Métodos de resposta

O objeto RES na onda restante fornece vários métodos para enviar respostas de volta ao cliente. Aqui estão os métodos suportados:

1. Res.json (dados)

   • Description : envia uma resposta JSON ao cliente.
   • Accepts : um objeto JavaScript ou uma string no formato json.
   • Example :

    res . json ( { message : "Success" , data : { name : "John" , age : 30 } } ) ;

2. Res.send (dados)

   • Description : envia uma resposta geral ao cliente.
   • Accepts : uma string ou vários tipos de dados, incluindo XML, SVG, HTML, formatos baseados em texto (por exemplo, CSS, SCG, texto sem formatação), etc. Os dados devem estar no formato da string.
   • Example :

    res . send ( "<h1>Welcome to my website!</h1>" ) ;

3. Res.sendfile (caminho)

   • Description : envia um arquivo como resposta ao cliente.
   • Accepts : o nome do caminho de um arquivo a ser enviado. Os tipos de arquivos suportados incluem CSS, PNG, JPEG/JPG, HTML, GIF, MP4, JS, JSON, PDF, etc.
   • Example :

    res . sendFile ( "/path/to/myfile.html" ) ;

É importante observar que os métodos Res.json () e Res.Send () definem automaticamente o cabeçalho do tipo conteúdo apropriado com base nos dados que estão sendo enviados, enquanto o res.sendFile () depende da extensão do arquivo para determinar o tipo de conteúdo.

Manuseio de erros

Também fornecemos mecanismo de manuseio de erros personalizado, onde você pode lidar com erros 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 ) ; 

Contribuindo

Congratulamo -nos com contribuições da comunidade de desenvolvedores para tornar a onda de descanso ainda melhor. Para contribuir, revise nossas diretrizes de contribuição aqui. Se você deseja relatar um bug, propor novos recursos ou enviar solicitações de tração, seu envolvimento é muito apreciado.

Licença

Restwave é de código aberto e liberado sob a licença do MIT. Sinta -se à vontade para usar, modificar e distribuí -lo de acordo com os termos da licença.

Contato

Twitter

Para qualquer pergunta ou feedback, entre em contato conosco em [email protected] Gostaríamos muito de ouvir você!

Comece a construir APIs RESTful poderosas com onda de descanso hoje e experimente a alegria do desenvolvimento de back -end eficiente com o Node.js!