ruserver

Biblioteca de Express para criar um servidor basico e configurado.

Importante

Esta biblioteca está em desenvolvimento, então pode conter bugs e não está completa. Baixe sempre a ultima versão, pois ela pode conter correções de bugs e novas funcionalidades. E fique de olho no README, pois ele pode conter informações importantes.

Sobre

Biblioteca RuServer de Ruan Fernandes. Feita em cima do Express, ela facilita a criação de um servidor basico e configurado com controladores. Ela usa Controllers para facilitar a criação de rotas e ações.

REPOSITÓRIO:

• GitHub

DOAÇÕES:

• PayPal

Como usar

Para usar a biblioteca, basta instalar ela com o comando:

npm i ruserver

Depois, basta importar a biblioteca no seu arquivo.ts

import { RuServer } from 'ruserver';
import { HelloWorld } from './HelloWorld';

const server = new RuServer(3000); // Porta do servidor (Opcional)
server.loadControllers([HelloWorld]);
server.start();

E criar um controller com o nome desejado, no meu caso HelloWorld.ts

// # Path: HelloWorld.ts
import { Controller, Get, Post, RequestData, Logger, Ok, BadRequest } from 'ruserver';
@Controller()
export class HelloWorld {
   
    constructor() {
        console.log('TestController created');
    }

    // Sem primeiro parametro, o método é chamado para o caminho "/"
    @Get('', 'Descricao do metodo')
    index(requestData: RequestData, extraParams: Map<string, any>) {
        // requestData e logger são injetados automaticamente
        // Não é necessário declarar os parâmetros, somente se precisar usa-los
        const Logger: Logger = extraParams.get("logger");

        Logger.info("TestController.index() called");

        // requestData.query é um objeto com os parâmetros da query string
        if (requestData.query.name) {
            return new Ok('Bem vindo ' + requestData.query.name);
        }

        // Tipos de Retorno Ok(data), Unauthorized(data), BadRequest(data), InternalError(data), NoContentOK(data)
        return new Ok('Bem vindo ao servidor');
    }

    @Get('test/:id')
    test(requestData: RequestData) {
        // requestData.params é um objeto com os parâmetros da URL
        return new Ok(`Test ${requestData.params.id}`);
    }

    @Post()
    post(requestData: RequestData) {
        if (!requestData.body.name) {
            return new BadRequest(`Name is required`);
        }

        // requestData.body é um objeto com os parâmetros do corpo da requisição
        return new Ok(`Post ${requestData.body.name}`);
    }
}

API

Após tudo feito, basta iniciar as requisições nas rotas criadas.

TODO

• [x] Criar biblioteca
• [x] Criar documentação
• [x] Criar exemplos
• [x] Criar função para modificar o status code da resposta
• [x] Criar função para modificar o cabeçalho da resposta
• [x] Criar função para modificar o corpo da resposta
• [ ] Criar função para autenticar o usuário

Exemplos

• [x] Criar um servidor basico
• [x] Criar um servidor com controladores
• [ ] Criar um servidor com autenticação
• [ ] Criar um servidor com banco de dados