feat(api): Adding route to get description of the api and fix the bugs.

felipeclarindo · felipeclarindo · commit 19ef8a4a2d3b · 2025-01-24T00:55:53.000-03:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.env
 
 target/
 !.mvn/wrapper/maven-wrapper.jar
diff --git a/README.md b/README.md
@@ -1,69 +1,79 @@
+🌍 [Leia em Português](README.pt-BR.md)
+
 # Tech Mech Api
 
-Esta é uma API desenvolvida em java para o projeto TechMec.
+This is an API developed in java in order to perform manipulations in the database for the Tech Mech project.
 
-## Funcionalidade
+## Technologies used
 
-- Autenticar o usuário
+- `Git` - Version control.
+- `Java`- Development of api.
+- `Maven` - Build automation and dependency management tool for the api.
 
-## Requisitos
+## Requirements for installation
 
-Certifique-se de ter o **Java** instalado em sua máquina e o **Compilador Java**
+Make sure you have the `node`, `npm` and `Java Development Kit` installed in your machine for run the project.
 
-## Passos para Instalação e Inicialização do projeto:
+## Steps for installation and run the API
 
-1. Clone o repositório:
+1. Clone the repository:
 
 ```bash
 git clone https://github.com/felipeclarindo/tech-mech-api.git
 ```
 
-2. Entre no diretorio da api:
+2. Enter the directory of api:
 
-```cd
+```bash
 tech-mech-api
 ```
 
-3. Inicie o arquivo `Main.java`.
+3. Configure your oracle database credentials in `src/main/java/resources/application.properties`.
+
+4. Execute sql locate at `sql/table/clients.sql` in the database.
+
+5. Run the file `Main.java`.
+
+## Steps for installation and run the Front-end
 
-4. Pronto a API está no ar, agora clone o repositório de Front:
+1. Clone the front end repository:
 
 ```bash
-git clone https://github.com/felipeclarindo/tech-mech
+git clone https://github.com/felipeclarindo/tech-mech.git
 ```
 
-5. Entre no diretorio:
+2. Enter the directory:
 
 ```bash
 cd tech-mech
 ```
 
-6. instale as dependencias:
+3. Now let's run the front-end (Make sure the api is running)
 
 ```bash
 npm install
 ```
 
-7. Rode o projeto localmente (certifique-se de que a API de java também esteja rodando):
+4. Run the project locally (make sure the java API is running as well):
 
 ```bash
 npm run dev
 ```
 
-8. Clique no link disponibilizado no terminal, normalmente:
+5. Click on the link provided in the terminal, usually:
 
-- http://localhost:3000
+- `http://localhost:3000`
 
-## Contribuição
+## Contribution
 
-Contribuições são bem-vindas! Se você tiver sugestões de melhorias, sinta-se à vontade para abrir uma issue ou enviar um pull request.
+Contributions are welcome! If you have suggestions for improvements, feel free to open an issue or submit a pull request.
 
-## Autores
+## Authors
 
 - [Felipe Clarindo](https://github.com/felipeclarindo)
 - [Victor Augusto](https://github.com/victoraugustogfavaro)
 - [Jennie Suzuki](https://github.com/jenniesuzuki)
 
-## Licença
+## License
 
-Este projeto está licenciado sob a [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).
+This project is licensed under the [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).
diff --git a/README.pt-BR.md b/README.pt-BR.md
@@ -0,0 +1,79 @@
+🌍 [Read in English](README.md)
+
+# Tech Mech Api
+
+Esta é uma API desenvolvida em java com o intuito de realizar manipulações no banco de dados para o projeto Tech Mech.
+
+## Tecnologias utilizadas
+
+- `Git` - Controle de Versão.
+- `Java`- Desenvolvimento da API.
+- `Maven` - Ferramenta de automação de build e gerenciamento de dependências para a api.
+
+## Requisitos para instalação
+
+Certifique-se de ter o `Java Development Kit`, `node`, `npm` instalado em sua máquina para executar o projeto.
+
+## Passos para instalação e para execução da API
+
+1. Clone o repositório da api:
+
+```bash
+git clone https://github.com/felipeclarindo/tech-mech-api.git
+```
+
+2. Entre no diretório:
+
+```bash
+cd tech-mech-api
+```
+
+3. Configure suas credenciais do banco de dados oracle em `src/main/java/resources/application.properties`.
+
+4. Execute no seu banco de dados oracle o sql localizado em `sql/table/clients.sql`.
+
+5. Execute o arquivo `Main.java`.
+
+## Passos para a instalação e executação do Front-end.
+
+1. Clone o repositorio do front end:
+
+```bash
+git clone https://github.com/felipeclarindo/tech-mech.git
+```
+
+2. Entre no diretório:
+
+```bash
+cd tech-mech
+```
+
+3. Instale as dependências:
+
+```bash
+npm install
+```
+
+4. Execute o projeto localmente. (Certifique-se de que a api já esteja sendo executada)
+
+```bash
+npm run dev
+```
+
+5. Clique no link disponibilizado no terminal, normalmente:
+
+- `http://localhost:3000`
+
+## Contribuição
+
+Contribuições são bem-vindas! Se você tiver sugestões de melhorias, sinta-se à vontade para abrir uma issue ou enviar um pull request.
+
+## Autores
+
+- [Felipe Clarindo](https://github.com/felipeclarindo)
+- [Victor Augusto](https://github.com/victoraugustogfavaro)
+- [Jennie Suzuki](https://github.com/jenniesuzuki)
+
+## Licença
+
+Este projeto está licenciado sob a [GNU Affero License](https://www.gnu.org/licenses/agpl-3.0.html).
diff --git a/pom.xml b/pom.xml
@@ -1,5 +1,5 @@
 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 
     <modelVersion>4.0.0</modelVersion>
 
@@ -31,10 +31,16 @@
             <artifactId>jersey-hk2</artifactId>
         </dependency>
 
-         <dependency>
+        <dependency>
             <groupId>org.glassfish.jersey.media</groupId>
             <artifactId>jersey-media-json-binding</artifactId>
         </dependency>
+        
+        <dependency>
+            <groupId>io.github.cdimascio</groupId>
+            <artifactId>dotenv-java</artifactId>
+            <version>3.0.0</version>
+        </dependency>
 
         <dependency>
             <groupId>com.oracle.database.jdbc</groupId>
@@ -95,5 +101,8 @@
         <jersey.version>3.1.8</jersey.version>
         <junit5.version>5.10.2</junit5.version>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <maven.compiler.source>15</maven.compiler.source>
+        <maven.compiler.target>15</maven.compiler.target>
     </properties>
+
 </project>
diff --git a/sql/table/clients.sql b/sql/table/clients.sql
@@ -0,0 +1,6 @@
+CREATE TABLE clients (
+    cpf VARCHAR(11) PRIMARY KEY,
+    nm_cliente VARCHAR(255) NOT NULL,
+    telefone VARCHAR(11) NOT NULL,
+    senha VARCHAR(255) NOT NULL  
+);
diff --git a/src/main/java/Main.java b/src/main/java/Main.java
@@ -20,8 +20,8 @@ public class Main {
      */
     public static HttpServer startServer() {
         // create a resource config that scans for JAX-RS resources and providers
-        // in br.com.fiap package
-        final ResourceConfig rc = new ResourceConfig().packages("br.com.fiap.resource");
+        // in resource package
+        final ResourceConfig rc = new ResourceConfig().packages("resource");
 
         // create and start a new instance of grizzly http server
         // exposing the Jersey application at BASE_URI
diff --git a/src/main/java/bo/ClienteBO.java b/src/main/java/bo/ClienteBO.java
@@ -1,8 +1,9 @@
 package bo;
 
+import java.util.ArrayList;
+
 import dao.ClienteDAO;
 import to.ClienteTO;
-import java.util.ArrayList;
 
 public class ClienteBO {
     private ClienteDAO clienteDAO;
diff --git a/src/main/java/dao/ConnectionFactory.java b/src/main/java/dao/ConnectionFactory.java
@@ -91,6 +91,4 @@ public String getPass() {
     public String getDriver() {
         return driver;
     }
-
-
 }
diff --git a/src/main/java/resource/ApiResource.java b/src/main/java/resource/ApiResource.java
@@ -0,0 +1,64 @@
+package resource;
+
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+import jakarta.ws.rs.core.MediaType;
+
+import java.util.HashMap;
+import java.util.Map;
+
+@Path("/api")
+public class ApiResource {
+
+    @GET
+    @Produces(MediaType.APPLICATION_JSON) // Indica que o retorno será em formato JSON
+    public Map<String, Object> getApiDescription() {
+        Map<String, Object> description = new HashMap<>();
+        description.put("welcome", "Welcome to the Tech Mech API!");
+        description.put("API status", "Running");
+        description.put("description", "Below are the available routes for managing clients:");
+
+        Map<String, Object> routes = new HashMap<>();
+
+        routes.put("GET /api/clients", Map.of(
+                "description", "Retrieve all registered clients.",
+                "response", "List of clients in JSON format."
+        ));
+
+        routes.put("GET /api/clients/{cpf}", Map.of(
+                "description", "Retrieve client details by CPF.",
+                "pathParameter", Map.of("cpf", "Client's CPF (e.g., 12345678900)."),
+                "response", "JSON object containing client details."
+        ));
+
+        routes.put("POST /api/clients", Map.of(
+                "description", "Add a new client.",
+                "requestBody", Map.of(
+                        "name", "Client's name (String)",
+                        "cpf", "Client's CPF (String)",
+                        "password", "Client's password (String)",
+                        "phone", "Client's phone number (String)"
+                ),
+                "response", "Success message with client ID."
+        ));
+
+        routes.put("PUT /api/clients/{cpf}", Map.of(
+                "description", "Update existing client details.",
+                "pathParameter", Map.of("cpf", "Client's CPF to update."),
+                "requestBody", "JSON object with updated client data.",
+                "response", "Success message indicating the update status."
+        ));
+
+        routes.put("DELETE /api/clients/{cpf}", Map.of(
+                "description", "Delete a client by CPF.",
+                "pathParameter", Map.of("cpf", "Client's CPF to delete."),
+                "response", "Success message indicating the deletion status."
+        ));
+
+        description.put("routes", routes);
+        description.put("note", "Use these endpoints to manage client information effectively. Ensure proper authentication and authorization when integrating this API.");
+
+        return description;
+    }
+}
diff --git a/src/main/java/resource/ClienteResource.java b/src/main/java/resource/ClienteResource.java
@@ -1,14 +1,22 @@
 package resource;
 
+import java.util.ArrayList;
+
 import bo.ClienteBO;
-import to.ClienteTO;
 import jakarta.validation.Valid;
-import jakarta.ws.rs.*;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.PUT;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.PathParam;
+import jakarta.ws.rs.Produces;
 import jakarta.ws.rs.core.MediaType;
 import jakarta.ws.rs.core.Response;
-import java.util.ArrayList;
+import to.ClienteTO;
 
-@Path("/techmec/clientes")
+@Path("/api/clients")
 public class ClienteResource {
     private ClienteBO clienteBO = new ClienteBO();
 
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties
@@ -1,4 +1,4 @@
-datasource.url=jdbc:oracle:thin:@oracle.fiap.com.br:1521:ORCL
-datasource.username=rm555059
-datasource.password=060505
+datasource.url=jdbc:oracle:thin:@yourdomain:yourport:yourservicename
+datasource.username=yourusername
+datasource.password=yourpassword
 datasource.driver-class-name=oracle.jdbc.driver.OracleDriver

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+.env`
`1`	`2`
`2`	`3`	`target/`
`3`	`4`	`!.mvn/wrapper/maven-wrapper.jar`
Original file line number	Diff line number	Diff line change
`@@ -91,6 +91,4 @@ public String getPass() {`
`91`	`91`	`public String getDriver() {`
`92`	`92`	`return driver;`
`93`	`93`	`}`
`94`		`-`
`95`		`-`
`96`	`94`	`}`