Lib Framework

Sobre

Este framework foi desenvolvido para facilitar a criação de APIs Node.js, fornecendo estrutura modular, validação, logging, rotas e integração com Swagger para documentação automática.

Pré-requisitos

• Node.js 12.12 ou superior

Instalação

npm install node-api-rest-framework

Inicialização

Crie um arquivo principal (ex: Index.js) e configure as variáveis de ambiente conforme necessário.

Variáveis de Ambiente

Defina as variáveis no seu arquivo .env ou diretamente no ambiente do sistema. Exemplos:

ENVIRONMENT=development
NAME_APP=MinhaAPI
NODE_PATH=src
PORT=3000
URL=http://localhost:3000
FILE_SIZE_POST_MB=10
DEBUG=true
DEBUG_POST=true
REQUEST_TIME_OUT=30000
CORS=true
SWAGGER_JSON=./controller/**/*.json
SWAGGER_URL=/api-docs
SWAGGER_VERSION=1.0
SWAGGER_TITLE=API
SWAGGER_SECURE=false
SWAGGER_CSS=./swagger.css
DEBUG_SYSTEM_STATUS=false

Descrição das Variáveis

• ENVIRONMENT: Ambiente de execução (ex: development, production).
• NAME_APP: Nome da aplicação.
• NODE_PATH: Caminho base dos arquivos Node.js.
• PORT: Porta do serviço.
• URL: URL base da API.
• FILE_SIZE_POST_MB: Tamanho máximo permitido para POST (em MB).
• DEBUG: Ativa logs de debug.
• DEBUG_POST: Exibe requisições recebidas.
• REQUEST_TIME_OUT: Tempo limite para execução (ms).
• CORS: Habilita CORS.
• SWAGGER_JSON: Caminho dos arquivos JSON do Swagger (ex: ./controller/**/*.json).
• SWAGGER_URL: URL para acessar a documentação Swagger (default: /api-docs).
• SWAGGER_VERSION: Versão da documentação Swagger.
• SWAGGER_TITLE: Título da documentação Swagger.
• SWAGGER_SECURE: Habilita autenticação na documentação Swagger (ex: '{"bearerAuth":{"type":"http","scheme":"bearer"}}').
• SWAGGER_CSS: Caminho para arquivo CSS customizado do Swagger.
• DEBUG_SYSTEM_STATUS: Ativa log do status do sistema.

Exemplo de Uso

// Index.js
require('dotenv').config();
const Main = require('./core/Main');

Main.start();

Testes

Os testes estão localizados na pasta tests/. Para executar:

npm test

Links Úteis

• Node.js
• Swagger

Contato

Dúvidas ou sugestões? Abra uma issue ou envie um e-mail para o mantenedor.