rafael-calixto1 / api-cc

api criada para fins educativos

CALCULO DE PASSAGEM PARA FUNCIONARIOS

Esta API acessa informações das APIs externas CNPJA que traz informações da Receita Federak e ViaCEP que traz informações do endereço do funcionário. Possui dois arquivos json para armazenar informções de empresas e de funcionarios.

Instalação

Para começar a usar a aplicação localmente, siga estas etapas:

Pré-requisitos

Certifique-se de ter o Node.js instalado na sua máquina. Você pode baixá-lo aqui.

Clonando o repositório

Clone este repositório para sua máquina local usando:

git clone https://github.com/rafael-calixto1/api-cc.git

Instalação

Entre na pasta da aplicação e instale as dependências usando o comando:

cd api-cc/projeto_api

Faça a instalação das dependências

npm install

Execução

Para executar a aplicação, use o comando:

npm start

A aplicação irá rodar na porta 3000 por padrão. Você poderá testar ela em http://localhost:3000

Informações sobre os Endpoints

Funcionarios

GET /api/funcionarios

• Descricao: Traz uma lista com todos os funcionarios
• Parameters: nenhum.
• Request Body: nenhum.

POST /api/funcionarios

• Descricao: Cria um novo funcionario
• Tipo de Requisicao
• Request Body Example:

{
   "nome": "nome",
   "sobrenome": "sobrenome",
   "cpf": "cpf",
   "cargo": "cargo",
   "empresa": "empresa",
   "cep": 777777777,
   "idempresa": 7
}

PUT /api/funcionarios

• Descricao: atualiza um funcionario
• Tipo de Requisicao
• Request Body Example:

{
   "nome" : "nome",
    "sobrenome" : "sobrenome",
    "cpf" : "cpf",
    "cargo" : "cargo",
    "empresa" : "empresa",
    "cep" : 777777777,
    "idempresa" : 7
}

GET /api/funcionarios/desempregados

• Descricao: Traz uma lista com todas as pessoas que não possuem empresa vinculada
• Parameters: nenhum.
• Request Body: nenhum.

GET /api/funcionarios/:idfuncionario/endereco

• Descricao: traz as informações do CEP da pessoa de acordo com o ID

• Requisicao por parametros

  Empresas

GET /api/empresas

• Descricao: Cria uma lista com as empresas
• Parameters: nenhum.
• Request Body: nenhum.

GET /api/empresas/:idempresa

• Descricao: Pega uma unica empresa
• Requisicao por parametros

GET /api/empresas/:idempresa/funcionarios

• Descricao: Traz uma lista com os funcionarios de uma unica empresa
• Requisicao por parametros

GET /api/empresas/:idempresa/informacoes

• Descricao: Traz informacoes da empresa acessando a API do CNPJA
• requisicao por parametros

POST /api/calculo

• Descricao: Gera o calculo de passagens
• requisicao por corpo de requisicao

{
    "idempresa" : 7,
    "idfuncionario" : 1
}

POST /api/empresas

• Descricao: Cria uma nova empresa
• requisicao por corpo de requisicao

 {
     "nome" : "BRAZ CUBAS",
    "cnpj" : "52556412000106"
}