How to add swagger to spring cloud gateway microservices application

 I know it is easy to add swagger to a spring boot ,Or spring MVC application. But ,what if your APIs runs behind a gateway!

The following steps illustreates how configure swagger to run behind gateway

Step 1: Updates on the Microservices applications

1- In the microservice project , add "io.springfox" maven to your pom.xml

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

2- in the SpringBootApplication class add annotation @EnableSwagger2 and add this bean

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)  
          .select()                                  
          .apis(RequestHandlerSelectors.any())              
          .paths(PathSelectors.any())                          
          .build();                                           
    }

 

save and run

 

Step 2 : Modification on the Spring cloud gateway application

1- add the same swagger dependency to the pom.xml file

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

 2- add routing to enable running swagger-ui and swagger-api

open the application.properties file and add two routes like this

# crm-operations/swagger-ui
spring.cloud.gateway.routes[2].id=sys-owner-app-swagger-ui
spring.cloud.gateway.routes[2].uri=lb://sys-owner-app
spring.cloud.gateway.routes[2].predicates[0]=Path=/sys-owner-app/swagger-resources/**
spring.cloud.gateway.routes[2].predicates[1]=Method=GET
spring.cloud.gateway.routes[2].filters[0]=RemoveRequestHeader=Cookie
spring.cloud.gateway.routes[2].filters[1]=RewritePath=/sys-owner-app/(?<segment>.*),/$\{segment}
# crm-operations/swagger-webjars
spring.cloud.gateway.routes[3].id=sys-owner-app-swagger-jars
spring.cloud.gateway.routes[3].uri=lb://sys-owner-app
spring.cloud.gateway.routes[3].predicates[0]=Path=/sys-owner-app/webjars/**
spring.cloud.gateway.routes[3].predicates[1]=Method=GET
spring.cloud.gateway.routes[3].filters[0]=RemoveRequestHeader=Cookie
spring.cloud.gateway.routes[3].filters[1]=RewritePath=/sys-owner-app/(?<segment>.*),/$\{segment}

# crm-operations/swagger-html
spring.cloud.gateway.routes[4].id=sys-owner-app-swagger-html
spring.cloud.gateway.routes[4].uri=lb://sys-owner-app
spring.cloud.gateway.routes[4].predicates[0]=Path=/sys-owner-app/swagger-ui/**
spring.cloud.gateway.routes[4].predicates[1]=Method=GET
spring.cloud.gateway.routes[4].filters[0]=RemoveRequestHeader=Cookie
spring.cloud.gateway.routes[4].filters[1]=RewritePath=/sys-owner-app/(?<segment>.*),/$\{segment}

example:


 

 Now Time For Testing:

The Swagger URL has been changes

The new URL is

http://<HOST_NAME>:<PORT>/<MICRO-SERVICE-NAME>/swagger-ui/index.html

example

http://localhost:802/sys-owner-app/swagger-ui/index.html

where localhost is thee servername, 802 is the gateway port, "sys-owner-app" is the name of your microservice

change the hostname and the port and the name of thee micro-service


 



Comments

Post a Comment

Popular posts from this blog

Another user has changed the row with primary key oracle.jbo.Key[12 ].

Image
Try these solutions:  make sure that you check "refresh after insert" and refresh after update" for the primary key column in you entity object. in the application module tab Click the Properties tab and select jbo.locking.mode. Double click the “pessimistic”value next to the property to open the field editor and type “optimistic” over the value.Press enter. if error still exist then you must set "refresh after insert" and refresh after update" as true for all attributes in the entity object another way is to execute the View Object after the commit operation to bring back updated data to ViewObject. For this we need to override the  afterCommit()  of ViewObject class as follows:                  public void afterCommit(TransactionEvent){                         executeQuery();                       }              5- another way to solve this error is to overide the lock() method of the EntityImpl class       public void lock() {    
Read more

weblogic windows JPS-01050: Opening of wallet based credential store failed. Reason java.io.IOException: Failed to lock cwallet.sso.lck

Integreated weblogic serer cannot be started and retuen this error weblogic windows JPS-01050: Opening of wallet based credential store failed. Reason java.io.IOException: Failed to lock cwallet.sso.lck Solution is simple  just remove the cwallet.sso file and cwallet.sso.lck located in C:\Users\tarek.DHAMAN\AppData\Roaming\JDeveloper\system12.2.1.4.42.190911.2248\o.jdeveloper.rescat2.model Then open jevveloper again and start weblogic again
Read more

Working With File Throgh WebUtill

-------------------------------------------------- Required Configuraion : By default the file transfer is disabled in webutil for a security measure. So, you have to enable File transfer configuration in webutil.cfg file. The webutil.cfg file is located in  forms\server. Open The webuil.cfg file and edit the following parameters : transfer.database.enabled=FALSE   Change To TRUE transfer.appsrv.enabled=FALSE       Change to TRUE WebUtil_File contains APIs to manipulate files and directories on the client. These Functions Or APIs are: Copy_File :  Copies a file Returns a Boolean to indicate success.  Syntax :   Webutil_File.Copy_File(SourceFileName in Varchar2 , Destination In Varchar2) Return Boolean  Example   Declare  vCopied Boolean;  Begin   vCopied :=  Webutil_File.Copy_File('C:\temp\mypic.jpg','X:\destination_folder');  If vCopied = true Then    Message('File copied Successfully');  Else   Message('Error in Copying File');  End if; Delete_File:
Read more