Agrix

Boas-vindas ao repositório Agrix.

Este projeto apresenta uma API RESTful que facilita a gestão e o monitoramento de fazendas, possibilitando às pessoas usuárias criar, visualizar, atualizar e excluir fazendas, plantações e fertilizantes de forma intuitiva e prática. A API oferece endpoints específicos para operações CRUD (Create, Read, Update, Delete) em listas de plantações e fazendas, visando proporcionar uma experiência consistente e confiável. Além de um autenticação e autorização de rotas.

Tecnologias e Ferramentas Utilizadas

Tecnologias

• Java Versão 17
• Spring Boot

Ferramentas

• IntelliJ IDEA
• Insomnia

Qualidade de código

No projeto, é utilizado o arquivo de configuração intellij-java-google-style.xml do Google, que define um conjunto de diretrizes de codificação baseadas nas práticas recomendadas do Google para Java.

Para executar a análise, utilize o comando:

mvn checkstyle:check

Como executar o Projeto

Instalação e Execução

1. Clone o repositório (Utilizar Link SSH)

2. Instalação e compilação dos recursos necessários

   mvn install -DskipTests

3. Inicializar projeto

   mvn spring-boot:run

Documentação

A documentação da API é gerada automaticamente através do Springdoc-openapi e estará disponível em Swagger UI através do endpoint http://localhost:8080/swagger-ui/index.html quando a aplicação estiver em execução. A documentação inclui detalhes sobre os endpoints disponíveis, os parâmetros necessários, os códigos de resposta e exemplos de solicitações.

Endpoints da Aplicação

Criação de Contato

• Método: POST
• URL: /persons
• Descrição: Cria novo usuário

Autenticação

• Método: POST
• URL: /auth/login
• Descrição: Autenticação de usuário

Criação de Fazenda

• Método: POST
• URL: /farms
• Descrição: Cria nova fazenda

Recuperação de Fazendas

• Método: GET
• URL: /farms
• Descrição: Retorna todas as fazendas disponíveis

Recuperação de Fazenda por ID

• Método: GET
• URL: /farms/{farmId}
• Descrição: Retorna informações de uma fazenda específica

Criação de Plantação

• Método: POST
• URL: /farms/{farmId}/crops
• Descrição: Cria nova plantação

Recuperação de Plantações

• Método: GET
• URL: /farms/{farmId}/crops
• Descrição: Retorna todas as plantações disponíveis em uma fazenda específica

Nota: Os outros endpoints podem ser encontrados na documentação no endpoint /swagger-ui/index.html

Realização de Requisições

Este arquivo contém uma coleção de endpoints para a plataforma Insomnia, que podem ser importados diretamente para a aplicação, simplificando o processo de teste e interação com a API.

• Insomnia_agrix.json

Contribuições

Yago Moreira

Trybe