Skip to main content
Version: 2.4.0

1. Overview

1.1 Plugin Name​

  • ContextPath Plugin

1.2 Appropriate Scenario​

  • Different services can do traffic governance of services by setting different context paths.

1.3 Plugin functionality​

  • Set the context path for service.
  • When the interface is called, the plug-in uniformly prefixes the interface address of the service.

1.4 Plugin Code​

  • Core module shenyu-plugin-context-path
  • Core class org.apache.shenyu.plugin.context.path.ContextPathPlugin

1.5 Added since which shenyu version​

  • 2.3.0

2. How to use plugin

2.1 Plugin-use procedure chart​

2.2 Import pom​

  • import maven config in shenyu-bootstrap project's pom.xml file.
  <dependency>
      <groupId>org.apache.shenyu</groupId>
      <artifactId>shenyu-spring-boot-starter-gateway</artifactId>
     <version>${project.version}</version>
  </dependency>

2.3 Enable plugin​

  • In shenyu-admin --> BasicConfig --> Plugin --> contextPath set Status enable.

2.4 Config plugin​

  • Set client project's contextPath.

  • Selector and rule config, please refer: Selector and rule config.
  • shenyu-admin contextPath plugin config, config contextPath and addPrefix, contextPath defines the value of contextPath,
  • and addPrefix defines the prefix that needs to be automatically added when the interface is called.

2.5 Examples​

2.5.1 Example set service context path​

2.5.1.1 Refer Local Deployment to start admin and bootstrap.​

2.5.1.2 Refer 2.2 to import pom and restart bootstrap.​

2.5.1.3 Refer 2.3 to enable plugin.​

2.5.1.4 Client project config contextPath.​

Client project can directly use shenyu-examples-http, and config contextPath in application.yml.

  • After the configuration is completed, and start client project, you can see that there is an additional context selector and rule configuration in shenyu-admin.

2.5.1.5 Call Interface​

2.5.2 Example add prefix​

2.5.2.1 Refer Local Deployment to start admin and bootstrap.​

2.5.2.2 Refer 2.2 to import pom and restart bootstrap.​

2.5.2.3 Refer 2.3 to enable plugin.​

2.5.2.4 Client project config contextPath.​

For client project we can directly use shenyu-examples-http, and config contextPath in application.yml.

  • After the configuration is completed, start client project, you can see that there is an additional context selector and rule configuration in shenyu-admin.

2.5.2.5 Config addPrefix​

2.5.2.6 Modify the value of uri in the selector and condition configuration to delete the addPrefix part.​

Since this example uses the service of the http protocol, we need to modify the divide plugin.

2.5.2.5 Call Interface​

3. How to disable plugin

  • In shenyu-admin --> BasicConfig --> Plugin --> contextPath set Status disable.