API RESTful para acessar hinos da Harpa Cristã.
- Endpoints:
- Listar todos os hinos
(GET /hymns) - Obter hino por ID
(GET /hymns/:id) - Buscar por título
(GET /hymns/search/title/:query) - Buscar por estrofe
(GET /hymns/search/verse/:query) - Buscar por número
(GET /hymns/search/number/:number) - Obter hino aleatório
(GET /hymns/random)
- Listar todos os hinos
- Node.js v16+
- Express
- MongoDB
- Requisitos: Node.js e MongoDB instalados.
- Clonar:
git clone https://github.com/rxpt/harpa-api.git - Instalar: npm install (dentro do diretório do projeto)
- Configurar:
- Copiar
.env.examplepara.env - Editar
.envcom suas configurações
- Copiar
- Popular o banco de dados:
- Os dados para popular o banco de dados estão presentes no projeto "harpa-crista-app".
- Iniciar: npm start
- cors: Permite requisições de origens diferentes.
- helmet: Segurança através de cabeçalhos HTTP.
- express.json(): Interpreta o corpo das requisições como JSON.
- errorHandler: Tratamento de erros personalizado.
- express-validator: Validação de parâmetros e queries.