12: Added swagger in user, order and notification server.

Author: subhashlamba

document/Auth2-0-Generate-Token.PNG

@@ -5,6 +5,7 @@ Spring boot microservice example with Eureka Server + Eureka Client + Spring Clo
  - **Eureka Server** : Eureka service registry
  - **Spring Cloud API Gateway**: API Gateway which is responsible to route the request to specific microservice
  - **Spring OAuth2.0**: Authentication service and responsible to secure the end points.
+    - Eureka Client
     - Generate OAuth token
     - Validate the OAuth token
  - **User Service**: User microservice with a basic feature 
@@ -13,15 +14,18 @@ Spring boot microservice example with Eureka Server + Eureka Client + Spring Clo
     - Supports RestTemplate Client 
     - Supports Resilience4J circuit breaker 
     - Use of Resilience4J circuit breaker with RestTemplate
- - **Order Service**: Order microservice with a basic feature (Eureka client)
+    - Swagger Document
+ - **Order Service**: Order microservice with a basic feature 
     - Eureka Client
     - OAuth2.0 Client  
     - Supports FeignClient Client
     - Supports Resilience4J circuit breaker
     - Use of Resilience4J circuit breaker with FeignClient 
+    - Swagger Document
  - **Notification Service**: Notification microservice with basic feature
 	- Eureka Client
     - OAuth2.0 Client  
+    - Swagger Document
 
 ## Checkout repository
 
@@ -67,7 +71,7 @@ Eureka server is running 8761 port, Now let's open it. Where we can check follow
 
 ### Eureka server : [http://localhost:8761/](http://localhost:8761/)
 
-![eureka server](eureka-server.PNG)
+![eureka server](document/eureka-server.PNG)
 
 ### Step 3: Configure Zipkin Server (Optional)
 
@@ -78,10 +82,12 @@ Eureka server is running 8761 port, Now let's open it. Where we can check follow
    ```
     3. Open zipkin server : [http://localhost:9411/](http://localhost:9411/)
 
-![Zipkin-Server](Zipkin-Server.PNG)
+![Zipkin-Server](document/Zipkin-Server.PNG)
 
 ## Step 4: Generate OAuth2.0 token
 
+### 4.1 Using curl
+
 ```sh
 curl -X POST \
   http://localhost:8080/oauth/token \
@@ -93,7 +99,19 @@ curl -X POST \
   -F username=zone1 \
   -F password=mypassword
 ```
+### 4.2 Using swagger
+    In the swagger UI, There is a "Autorize" button on the top, click on it it will open the following popup:
+
+![eureka server](./document/Auth2-0-Generate-Token.PNG)
+
+Use the following information
 
+```
+Username: zone1
+Password: mypassword
+ClientId: javadeveloperzone
+Secret: secret
+```
 Output 
 
 ```sh
@@ -108,6 +126,7 @@ Output
 
 ## Step 5: Create user using user microservice
 
+### 5.1 Using curl
 ```
 curl -X POST \
   http://localhost:8080/user/ \
@@ -118,9 +137,14 @@ curl -X POST \
   -d '{"firstName":"subhash", "lastName": "Lamba"}'
  
  ```
+### 5.2 Using Swagger UI
+
+![eureka server](./document/User-Microservice-Swagger.PNG)
 
 ## Step 6: Create order using order microservice
 
+ 
+### 6.1 Using curl 
 ```
 curl -X POST \
   http://localhost:8080/order/ \
@@ -131,8 +155,14 @@ curl -X POST \
   -d '{"userId":1, "orderDate": "2021-01-01"}'
 ```
 
+### 6.2 Using Swagger UI
+
+![eureka server](./document/Order-Microservice-Swagger.PNG)
+
+
 ## Step 7: Get user and order using user microservice
 
+### 7.1 Using curl 
 ```
 curl -X GET \
   http://localhost:8080/user/1 \
@@ -160,5 +190,11 @@ curl -X GET \
 }
 ```
 
+### 7.1 Using Swagger UI 
+
+![eureka server](./document/User-Microservice-Swagger.PNG)
+
+
+
 
 

document/Notification-Microservice-Swagger.PNG

@@ -3,6 +3,13 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.cors.reactive.CorsWebFilter;
+import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;
+
+import java.util.Arrays;
+import java.util.Collections;
 
 @SpringBootApplication
 @EnableEurekaClient
@@ -11,3 +18,21 @@ public static void main(String[] args) {
         SpringApplication.run(SpringBootConfig.class, args);            // it wil start application
     }
 }
+
+@Configuration
+ class CorsConfiguration{
+    @Bean
+    public CorsWebFilter corsWebFilter() {
+
+        org.springframework.web.cors.CorsConfiguration corsConfig = new org.springframework.web.cors.CorsConfiguration();
+        corsConfig.setAllowedOrigins(Collections.singletonList("*"));
+        corsConfig.setMaxAge(3600L);
+        corsConfig.setAllowedMethods(Arrays.asList("GET", "POST"));
+        corsConfig.addAllowedHeader("*");
+
+        final UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
+        source.registerCorsConfiguration("/**", corsConfig);
+
+        return new CorsWebFilter(source);
+    }
+}

document/Order-Microservice-Swagger.PNG

@@ -8,13 +8,19 @@
 import org.springframework.security.config.annotation.web.builders.HttpSecurity;
 import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 import org.springframework.security.crypto.password.NoOpPasswordEncoder;
+import org.springframework.web.cors.CorsConfiguration;
+import org.springframework.web.cors.CorsConfigurationSource;
+import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
+
+import java.util.Arrays;
 
 @Configuration
 public class SecurityConfig extends WebSecurityConfigurerAdapter {
 
     @Override
     protected void configure(HttpSecurity http) throws Exception {
         http
+                .cors().and()
                 .antMatcher("/**")
                 .authorizeRequests()
                 .antMatchers("/", "/login**")
@@ -46,4 +52,14 @@ public static NoOpPasswordEncoder passwordEncoder() {
     public AuthenticationManager authenticationManagerBean() throws Exception {
         return super.authenticationManagerBean();
     }
+
+    @Bean
+    CorsConfigurationSource corsConfigurationSource() {
+        CorsConfiguration configuration = new CorsConfiguration();
+        configuration.setAllowedOrigins(Arrays.asList("*"));
+        configuration.setAllowedMethods(Arrays.asList("GET","POST"));
+        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
+        source.registerCorsConfiguration("/**", configuration);
+        return source;
+    }
 }

document/User-Microservice-Swagger.PNG

@@ -6,7 +6,7 @@ spring:
       name: subhash
       password: subhash
 server:
-  port: 8686
+  port: 8484
 eureka:
   instance:
     hostname: localhost

Zipkin-Server.PNG renamed to document/Zipkin-Server.PNG

@@ -11,8 +11,8 @@
     <groupId>com.javadeveloperzone</groupId>
     <artifactId>microservce-example</artifactId>
     <version>0.0.1-SNAPSHOT</version>
-    <name>spring-microservice-user-service</name>
-    <description>Sprig boot microservice user service</description>
+    <name>spring-microservice-notification-service</name>
+    <description>Sprig boot microservice notification service</description>
     <properties>
         <java.version>11</java.version>
         <spring-cloud.version>2020.0.2</spring-cloud.version>
@@ -85,7 +85,21 @@
             <artifactId>h2</artifactId>
             <scope>runtime</scope>
         </dependency>
-        
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.7.0</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.7.0</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-bean-validators</artifactId>
+            <version>2.7.0</version>
+        </dependency>
     </dependencies>
     <dependencyManagement>
         <dependencies>

eureka-server.PNG renamed to document/eureka-server.PNG

@@ -0,0 +1,5 @@
+# Notification Service - Eureka Client
+
+    Following API available in notification Service
+
+![eureka server](../document/Notification-Microservice-Swagger.PNG)

readme.md

@@ -0,0 +1,98 @@
+package com.javadeveloperzone.config;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.http.HttpHeaders;
+import springfox.documentation.builders.ApiInfoBuilder;
+import springfox.documentation.builders.PathSelectors;
+import springfox.documentation.builders.RequestHandlerSelectors;
+import springfox.documentation.service.*;
+import springfox.documentation.spi.DocumentationType;
+import springfox.documentation.spi.service.contexts.SecurityContext;
+import springfox.documentation.spring.web.plugins.Docket;
+import springfox.documentation.swagger.web.ApiKeyVehicle;
+import springfox.documentation.swagger.web.SecurityConfiguration;
+import springfox.documentation.swagger2.annotations.EnableSwagger2;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.List;
+
+@Configuration
+@EnableSwagger2
+public class SwaggerConfig {
+
+    @Bean
+    public Docket productApi() {
+        return new Docket(DocumentationType.SWAGGER_2)
+
+                .select()
+                .apis(RequestHandlerSelectors.any())
+                .paths(PathSelectors.any())
+                .build()
+                .securityContexts(Collections.singletonList(securityContext()))
+                .securitySchemes(Arrays.asList(securitySchema()))
+                .apiInfo(apiEndPointsInfo());
+    }
+
+
+    private ApiInfo apiEndPointsInfo() {
+        return new ApiInfoBuilder().title("Job Platform REST API")
+                .description("REST APIs for Job Platform Application")
+                .contact(new Contact("Subhash Lamba", "https://prominentpixel.com/", "info@prominentpixel.com"))
+                .license("Apache 2.0")
+                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
+                .version("1.0-SNAPSHOT")
+                .build();
+    }
+
+    private OAuth securitySchema() {
+
+        List<AuthorizationScope> authorizationScopeList = new ArrayList<>();
+        authorizationScopeList.add(new AuthorizationScope("read", "read all"));
+        authorizationScopeList.add(new AuthorizationScope("write", "access all"));
+
+        List<GrantType> grantTypes = new ArrayList();
+        GrantType passwordCredentialsGrant = new ResourceOwnerPasswordCredentialsGrant("http://localhost:8080/oauth/token");
+        grantTypes.add(passwordCredentialsGrant);
+
+        return new OAuth("oauth2", authorizationScopeList, grantTypes);
+    }
+
+    private SecurityContext securityContext() {
+        return SecurityContext.builder().securityReferences(defaultAuth())
+                .build();
+    }
+
+    private List<SecurityReference> defaultAuth() {
+
+        final AuthorizationScope[] authorizationScopes = new AuthorizationScope[3];
+        authorizationScopes[0] = new AuthorizationScope("read", "read all");
+        authorizationScopes[1] = new AuthorizationScope("trust", "trust all");
+        authorizationScopes[2] = new AuthorizationScope("write", "write all");
+
+        return Collections.singletonList(new SecurityReference("oauth2", authorizationScopes));
+    }
+
+    @Bean
+    public SecurityConfiguration security() {
+        return new SecurityConfiguration
+                ("client", "secret", "", "", "", ApiKeyVehicle.HEADER, HttpHeaders.AUTHORIZATION,"");
+    }
+
+    /**
+     *
+     * @return ApiInf
+     */
+    private ApiInfo apiInfo() {
+        return new ApiInfoBuilder().title("Authentication API").description("")
+                .termsOfServiceUrl("https://www.example.com/api")
+                .contact(new Contact("Developers", "https://projects.spring.io/spring-boot/", ""))
+                .license("Open Source")
+                .licenseUrl("\"https://www.apache.org/licenses/LICENSE-2.0")
+                .version("1.0.0")
+                .build();
+
+    }
+}

spring-boot-cloud-api-gateway-routing/src/main/java/com/javadeveloperzone/SpringBootConfig.java

@@ -5,7 +5,7 @@ spring:
     base-url: http://localhost:9411/
 
 server:
-  port: 0
+  port: 8383
 eureka:
   instance:
     hostname: localhost

spring-boot-cloud-authentication-service/src/main/java/com/javadeveloperzone/config/SecurityConfig.java

@@ -90,6 +90,21 @@
             <artifactId>h2</artifactId>
             <scope>runtime</scope>
         </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger2</artifactId>
+            <version>2.7.0</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-swagger-ui</artifactId>
+            <version>2.7.0</version>
+        </dependency>
+        <dependency>
+            <groupId>io.springfox</groupId>
+            <artifactId>springfox-bean-validators</artifactId>
+            <version>2.7.0</version>
+        </dependency>
     </dependencies>
     <dependencyManagement>
         <dependencies>

spring-boot-cloud-authentication-service/src/main/resources/application.properties

@@ -0,0 +1,5 @@
+# Order Service - Eureka Client
+
+    Following API available in Order Service
+
+![eureka server](../document/Order-Microservice-Swagger.PNG)