Este é um projeto API RESTful para Sistema de Usuários de Carros.
Antes de executar este projeto, certifique-se de ter as seguintes ferramentas e recursos instalados:
-
Java 17: É necessário ter o Java Development Kit (JDK) versão 17.
-
Maven: O Maven é uma ferramenta de gerenciamento de dependências e construção de projetos. Você deve instalá-lo para compilar e executar este projeto.
-
Postman: O Postman é uma ferramenta útil para testar APIs REST. Você pode usá-lo para interagir com a API deste projeto.
Siga estas etapas para executar o projeto:
- Clone este repositório em sua máquina:
02 - git clone https://github.com/jonathannjefferson/DesafioAPI.git
03 - Navegue até o diretório do projeto.
04 - Compile o projeto usando o Maven: mvn clean install
05 - após isso é só rodar o projeto e testar no postman.
Obs: para testar a API é necessario utilizar o postman, dentro do projeto há um folder chamado postman onde possui a collections exportada.
Para importar a collections seguir os seguintes passos:
Abra o Postman: Inicie o aplicativo Postman em seu computador.
Faça login (se necessário): Se você não estiver logado no Postman, faça login com sua conta.
Abra o Gerenciador de Coleções: No painel à esquerda, clique na guia "Coleções" para abrir o Gerenciador de Coleções.
Importe a Coleção:
clique no botão "Importar" no canto superior direito do Gerenciador de Coleções.
Selecione a Coleção: Após importar com sucesso, a coleção aparecerá na lista de coleções no Gerenciador de Coleções. Clique na coleção para abri-la.
Execute as Solicitações: Dentro da coleção, você verá uma lista de solicitações. Clique em uma solicitação específica para abri-la e, em seguida, clique no botão "Enviar" para executá-la.
Você pode encontrar a documentação no projeto como swagger.yaml
OBS: Futuras evoluções estão por vir neste projeto, incluindo uma refatoração.
Se você deseja contribuir para este projeto, sinta-se à vontade para abrir um problema ou enviar uma solicitação pull. Estamos felizes em receber contribuições.