Merge pull request #332 from vinho-notas/VIN-394-Criar-o-arquivo-READ…

…ME.md-com-a-documentacao-de-cada-micro-servico

Vin 394 criar o arquivo readme.md com a documentacao de cada micro servico

avaliacao/README.md

@@ -0,0 +1,44 @@
+# Serviço de Avaliação de Vinho
+
+Este é um serviço baseado em Java para gerenciar o micro serviço de avaliação de vinho. Ele usa PostgreSQL para armazenamento de dados e Maven para gerenciamento de projetos.
+
+## Estrutura do Projeto
+
+O projeto é estruturado em vários pacotes:
+- `com.vinhonotas.avaliacao.domain`: Contém as regras de negócio.
+- `com.vinhonotas.avaliacao.application`: Contém classes de serviços para as regras de negócio.
+- `com.vinhonotas.avaliacao.interfaces`: Contém classes de controle para manipulação de solicitações HTTP.
+- `com.vinhonotas.avaliacao.infrastructure`: Contém classes de repositório para acesso a dados.-
+- `com.vinhonotas.avaliacao.configuration`: Contém classes de configuração.
+- `com.vinhonotas.avaliacao.utils`: Contém classes utilitárias.
+
+## Configuração
+
+Para configurar o projeto, você precisa ter o Java e o Maven instalados. Em seguida, você pode clonar o repositório e executar `mvn install` para instalar as dependências necessárias.
+
+## Uso
+
+Você pode iniciar o aplicativo executando `mvn spring-boot:run`. O serviço estará disponível em `http://localhost:8082/swagger-ui/index.html`.
+
+## Endpoints
+
+### Point Scales: Operações relacionadas a avaliação de vinhos
+
+GET
+- `/api/v1/point-scales/{id}`: Retorna uma avaliação de vinho pelo id.
+
+PUT
+- `/api/v1/point-scales/{id}`: Atualiza uma avaliação de vinho pelo id.
+
+DELETE
+- `/api/v1/point-scales/{id}`: Deleta uma avaliação de vinho pelo id.
+
+GET
+- `/api/v1/point-scales`: Retorna todas as avaliações de vinho.
+
+POST
+- `/api/v1/point-scales`: Cria uma avaliação de vinho.
+
+## Licença
+
+Este projeto está licenciado sob a Licença MIT - veja o arquivo `LICENSE.md` para detalhes

bff/README.md

@@ -0,0 +1,245 @@
+# Serviço de BFF
+
+Este é um serviço baseado em Java para gerenciar o BFF - back end for front end.
+
+## Estrutura do Projeto
+
+O projeto é estruturado em vários pacotes:
+- `com.vinhonotas.bff.domain`: Contém as regras de negócio.
+- `com.vinhonotas.bff.application`: Contém classes de serviços para as regras de negócio.
+- `com.vinhonotas.bff.interfaces`: Contém classes de controle para manipulação de solicitações HTTP.
+- `com.vinhonotas.bff.infrastructure`: Contém classes de repositório para acesso a dados.-
+- `com.vinhonotas.bff.configuration`: Contém classes de configuração.
+- `com.vinhonotas.bff.utils`: Contém classes utilitárias.
+
+## Configuração
+
+Para configurar o projeto, você precisa ter o Java e o Maven instalados. Em seguida, você pode clonar o repositório e executar `mvn install` para instalar as dependências necessárias.
+
+## Uso
+
+Você pode iniciar o aplicativo executando `mvn spring-boot:run`. O serviço estará disponível em `http://localhost:8084/swagger-ui/index.html`.
+
+## Endpoints
+
+### wine-controller
+
+GET
+- `/api/v1/wines/{id}`:
+
+PUT
+- `/api/v1/wines/{id}`:
+
+DELETE
+- `/api/v1/wines/{id}`:
+
+GET
+- `/api/v1/wines`:
+
+POST
+- `/api/v1/wines`:
+
+### visual-inspection-controller
+
+GET
+- `/api/v1/visual-inspection/{id}`:
+
+PUT
+- `/api/v1/visual-inspection/{id}`:
+
+DELETE
+- `/api/v1/visual-inspection/{id}`:
+
+GET
+- `/api/v1/visual-inspection`:
+
+POST
+- `/api/v1/visual-inspection`:
+
+### user-controller
+
+GET
+- `/api/v1/users/{id}`:
+
+PUT
+- `/api/v1/users/{id}`:
+
+DELETE
+- `/api/v1/users/{id}`:
+
+GET
+- `/api/v1/users`:
+
+POST
+- `/api/v1/users`:
+
+GET
+- `/api/v1/users/name/{name}`:
+
+### tasting-controller
+
+GET
+- `/api/v1/tasting/{id}`:
+
+PUT
+- `/api/v1/tasting/{id}`:
+
+DELETE
+- `/api/v1/tasting/{id}`:
+
+GET
+- `/api/v1/tasting`:
+
+POST
+- `/api/v1/tasting`:
+
+### tasting-card-controller
+
+GET
+- `/api/v1/tasting-card/{id}`:
+
+PUT
+- `/api/v1/tasting-card/{id}`:
+
+DELETE
+- `/api/v1/tasting-card/{id}`:
+
+GET
+- `/api/v1/tasting-card`:
+
+POST
+- `/api/v1/tasting-card`:
+
+### point-scale-controller
+
+GET
+- `/api/v1/point-scales/{id}`:
+
+PUT
+- `/api/v1/point-scales/{id}`:
+
+DELETE
+- `/api/v1/point-scales/{id}`:
+
+GET
+- `/api/v1/point-scales`:
+
+POST
+- `/api/v1/point-scales`:
+
+### person-controller
+
+GET
+- `/api/v1/persons/{id}`:
+
+PUT
+- `/api/v1/persons/{id}`:
+
+DELETE
+- `/api/v1/persons/{id}`:
+
+GET
+- `/api/v1/persons`:
+
+POST
+- `/api/v1/persons`:
+
+GET
+- `/api/v1/persons/name/{name}`:
+
+### olfactory-inspection-controller
+
+GET
+- `/api/v1/olfactory-inspection/{id}`:
+
+PUT
+- `/api/v1/olfactory-inspection/{id}`:
+
+DELETE
+- `/api/v1/olfactory-inspection/{id}`:
+
+GET
+- `/api/v1/olfactory-inspection`:
+
+POST
+- `/api/v1/olfactory-inspection`:
+
+### gustatory-inspection-controller
+
+GET
+- `/api/v1/gustatory-inspection/{id}`:
+
+PUT
+- `/api/v1/gustatory-inspection/{id}`:
+
+DELETE
+- `/api/v1/gustatory-inspection/{id}`:
+
+GET
+- `/api/v1/gustatory-inspection`:
+
+POST
+- `/api/v1/gustatory-inspection`:
+
+### aromas-controller
+
+GET
+- `/api/v1/aromas/{id}`:
+
+PUT
+- `/api/v1/aromas/{id}`:
+
+DELETE
+- `/api/v1/aromas/{id}`:
+
+GET
+- `/api/v1/aromas`:
+
+POST
+- `/api/v1/aromas`:
+
+### address-controller
+
+GET
+- `/api/v1/address/{id}`:
+
+PUT
+- `/api/v1/address/{id}`:
+
+DELETE
+- `/api/v1/address/{id}`:
+
+GET
+- `/api/v1/address`:
+
+POST
+- `/api/v1/address`:
+
+### state-controller
+
+GET
+- `/api/v1/states`:
+
+GET
+- `/api/v1/states/{id}`:
+
+GET
+- `/api/v1/states/uf/{uf}`:
+
+GET
+- `/api/v1/states/name/{name}`:
+
+### country-controller
+
+GET
+- `/api/v1/countries`:
+
+GET
+- `/api/v1/countries/{id}`:
+
+GET
+- `/api/v1/countries/name/{name}`:
+
+## Licença
+
+Este projeto está licenciado sob a Licença MIT - veja o arquivo `LICENSE.md` para detalhes

bff/pom.xml

@@ -47,6 +47,16 @@
 			<artifactId>spring-boot-starter-test</artifactId>
 			<scope>test</scope>
 		</dependency>
+		<dependency>
+			<groupId>org.springdoc</groupId>
+			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
+			<version>2.2.0</version>
+		</dependency>
+		<dependency>
+			<groupId>io.springfox</groupId>
+			<artifactId>springfox-boot-starter</artifactId>
+			<version>3.0.0</version>
+		</dependency>
 	</dependencies>
 	<dependencyManagement>
 		<dependencies>

bff/src/main/java/com/vinhonotas/bff/configuration/SwaggerConfiguration.java

@@ -0,0 +1,35 @@
+package com.vinhonotas.bff.configuration;
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Contact;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.info.License;
+import io.swagger.v3.oas.models.servers.Server;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class SwaggerConfiguration {
+
+    @Bean
+    public OpenAPI openApiInformation() {
+        Server localServer =
+                new Server()
+                        .url("http://localhost:8084")
+                        .description("Localhost Server URL");
+        Contact contact = new Contact()
+                .email("vanderlei.master@gmail.com")
+                .name("Vanderlei Kleinschmidt");
+        Info info = new Info()
+                .contact(contact)
+                .description("BFF - Back end For Front end")
+                .title("BFF").version("V0.0.1")
+                .license(new License()
+                        .name("Apache 2.0")
+                        .url("http://springdoc.org"));
+
+        return new OpenAPI()
+                .info(info)
+                .addServersItem(localServer);
+    }
+}

bff/src/main/resources/application.yaml

@@ -14,3 +14,7 @@ avaliacao-api:
 
 degustacao-api:
   url: "http://localhost:8083/api/v1"
+
+springdoc:
+  api-docs:
+    path: /api-docs