Ploomes Employee API

Esse projeto é uma API que cadastra e consulta dados de funcionários em um banco de dados.

Como funciona o Serviço

A API é baseada no Swagger que permite realizar as chamadas dos métodos, além de deixar registrado dentro do próprio Swagger quais são os métodos, os resultados e os parâmetros esperados

Os métodos da API são:

• GET /api/Employees Busca a lista dos funcionários cadastrados
• POST /api/Employees Cadastra um funcionário
• GET /api/Employees/{id} Busca um funcionário pelo Id (identificador único de cadastro)

Começando

Escolha um dos 2 ambientes abaixo para rodar o projeto:

1. Ambiente de Produção (live)

Para utilizar o serviço na nuvem, acesse o link abaixo (O serviço foi desativado):

https://ploomesapi.azurewebsites.net/swagger/index.html

2. Ambiente de Desenvolvimento (localhost)

Tecnologias

Garanta que você possui os seguintes pré-requisitos instalados

• .NET CORE 5
  • SDK .NET 5
• Banco de Dados
  • SQL Server Management Studio (SSMS) (Windows) OU
  • Azure Data Studio em conjunto com Docker Desktop e a imagem do Microsoft SQL Server (Multiplataforma)
• IDE/Editor de código
  • Visual Studio (Windows e MAC) OU
  • Visual Studio Code (Multiplataforma) OU
  • JetBrains Rider (Multiplataforma)

Configurações / Build

• Faça o clone do projeto localmente:
  Rode o comando git clone https://github.com/andrenunes57/Ploomes-API.git

• Altere a string de conexão: Na pasta raiz do projeto, no arquivo appsettings.json, altere o valor da chave "ServerConnection" para a string de conexão do seu banco de dados local

• Garanta que os pacotes NuGet estão restaurados: Na pasta raiz do projeto Ploomes-API/, rode o comando dotnet restore

• Crie o banco de dados local através do Migrations:
  (Se a IDE for o Visual Studio) -> abra o Console do Gerenciador de Pacotes e rode o comando update-database. (Se estiver usando outra IDE) -> instale o ef tool, rodando o comando dotnet tool install --global dotnet-ef e, da pasta raiz, navegue para a pasta do projeto Ploomes-API/PloomesAPI/ e rode o comando dotnet ef database update

• Verifique se o banco da aplicação é listado no software de banco de dados: O banco de dados terá o nome dado na string de conexão. Caso não tenha alterado o nome, aparecerá como "Ploomes"

• Rode a aplicação

• Deverá abrir o Swagger no localhost, num link com o seguinte formato: https://localhost:xxxxx/swagger/index.html

• Utilize os métodos da API conforme informado no início do README ou na documentação dentro do próprio Swagger.