Esta é uma API de uma aplicação web que lista os 5 melhores matchs (candidatos) para uma vaga.
- Node.js - JavaScript runtime
- Express - O framework web utilizado
- MongoDB - Base de dados não relacional
- Yarn - Gerenciador de pacotes e dependências
Com as instruções a seguir você terá uma cópia do projeto rodando em sua máquina local para propósitos de testes e desenvolvimento.
git clone https://github.com/Lorenalgm/job-match-api.git
cd job-match-api
- Node.js versão 10 ou superior
- Um gerenciador de dependências - Yarn ou NPM
- Uma instância local ou um cluster do MongoDB
npm install
ou
yarn
npm run dev
ou
yarn dev
Para rodar os testes existentes criados com jest, você pode utilizar:
npm run test
ou
yarn test
Para guiar a qualidade do código, este repositório foi integrado ao CodeClimate, obtendo até o presente momento o resultado:
Os serviços disponíveis nesta API são:
Utilize a API de candidatos sempre que precisar buscar os matchs para uma vaga.
GET: /candidates
Listar todos os candidatos;
| Campo | Descrição | Tipo de dado | Obrigatório |
|-----------|-----------|-------------------|--------------|------------|
| city
| Cidade | String
| Sim |
| experience
| Experiência | String
| Sim |
| technologies
| Tecnologias | Array
| Sim |
URL de Requisição
Retorna um Array dos objetos de candidatos.
[
{
"id": 105599,
"city": "Fortaleza - CE",
"experience": "0-1 years",
"technologies": [
{
"name": "Kotlin",
"is_main_tech": true
},
{
"name": "Java",
"is_main_tech": false
},
{
"name": "Java (Android)",
"is_main_tech": false
},
{
"name": "Python",
"is_main_tech": false
},
{
"name": "Flask",
"is_main_tech": false
},
{
"name": "Django",
"is_main_tech": false
},
{
"name": "Flutter",
"is_main_tech": true
}
]
},
{...},
{...}
]
POST: /candidates
Criar um novo candidato;
Body
{
"city": "Fortaleza - CE",
"experience": "0-1 years",
"technologies": [
{
"name": "React",
"is_main_tech": true
}
]
}
URL de Requisição
- Lorena Montes - Lorenalgm