| <!doctype html> |
| <html lang="en" dir="ltr" class="docs-wrapper plugin-docs plugin-id-default docs-version-2.7.0.3 docs-doc-page docs-doc-id-plugin-center/http-process/contextpath-plugin" data-has-hydrated="false"> |
| <head> |
| <meta charset="UTF-8"> |
| <meta name="generator" content="Docusaurus v3.9.2"> |
| <title data-rh="true">ContextPath Plugin | Apache ShenYu</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://shenyu.apache.org/docs/plugin-center/http-process/contextpath-plugin"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" property="og:locale:alternate" content="zh"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="2.7.0.3"><meta data-rh="true" name="docusaurus_tag" content="docs-default-2.7.0.3"><meta data-rh="true" name="docsearch:version" content="2.7.0.3"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-2.7.0.3"><meta data-rh="true" property="og:title" content="ContextPath Plugin | Apache ShenYu"><meta data-rh="true" name="description" content="contextPath plugin"><meta data-rh="true" property="og:description" content="contextPath plugin"><meta data-rh="true" name="keywords" content="contextPath"><link data-rh="true" rel="icon" href="/img/favicon.svg"><link data-rh="true" rel="canonical" href="https://shenyu.apache.org/docs/plugin-center/http-process/contextpath-plugin"><link data-rh="true" rel="alternate" href="https://shenyu.apache.org/docs/plugin-center/http-process/contextpath-plugin" hreflang="en"><link data-rh="true" rel="alternate" href="https://shenyu.apache.org/zh/docs/plugin-center/http-process/contextpath-plugin" hreflang="zh"><link data-rh="true" rel="alternate" href="https://shenyu.apache.org/docs/plugin-center/http-process/contextpath-plugin" hreflang="x-default"><script data-rh="true" type="application/ld+json">{"@context":"https://schema.org","@type":"BreadcrumbList","itemListElement":[{"@type":"ListItem","position":1,"name":"ContextPath Plugin","item":"https://shenyu.apache.org/docs/plugin-center/http-process/contextpath-plugin"}]}</script><link rel="alternate" type="application/rss+xml" href="/blog/rss.xml" title="Apache ShenYu RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/blog/atom.xml" title="Apache ShenYu Atom Feed"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <link rel="alternate" type="application/rss+xml" href="/news/rss.xml" title="Apache ShenYu RSS Feed"> |
| <link rel="alternate" type="application/atom+xml" href="/news/atom.xml" title="Apache ShenYu Atom Feed"> |
| |
| <script src="/js/error-suppression.js"></script><link rel="stylesheet" href="/assets/css/styles.5a6c781d.css"> |
| <script src="/assets/js/runtime~main.2f4518ab.js" defer="defer"></script> |
| <script src="/assets/js/main.a08b9f10.js" defer="defer"></script> |
| </head> |
| <body class="navigation-with-keyboard"> |
| <svg style="display: none;"><defs> |
| <symbol id="theme-svg-external-link" viewBox="0 0 24 24"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"/></symbol> |
| </defs></svg> |
| <script>!function(){var t=function(){try{return new URLSearchParams(window.location.search).get("docusaurus-theme")}catch(t){}}()||function(){try{return window.localStorage.getItem("theme")}catch(t){}}();document.documentElement.setAttribute("data-theme",t||"light"),document.documentElement.setAttribute("data-theme-choice",t||"light")}(),function(){try{const c=new URLSearchParams(window.location.search).entries();for(var[t,e]of c)if(t.startsWith("docusaurus-data-")){var a=t.replace("docusaurus-data-","data-");document.documentElement.setAttribute(a,e)}}catch(t){}}()</script><div id="__docusaurus"><div role="region" aria-label="Skip to main content"><a class="skipToContent_fXgn" href="#__docusaurus_skipToContent_fallback">Skip to main content</a></div><nav aria-label="Main" class="theme-layout-navbar navbar navbar--fixed-top"><div class="navbar__inner"><div class="theme-layout-navbar-left navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo.svg" alt="Apache ShenYu Logo" class="themedComponent_mlkZ themedComponent--light_NVdE"><img src="/img/logo-light.svg" alt="Apache ShenYu Logo" class="themedComponent_mlkZ themedComponent--dark_xIcU"></div></a></div><div class="theme-layout-navbar-right navbar__items navbar__items--right"><a class="navbar__item navbar__link" href="/download">Download</a><a class="navbar__item navbar__link" href="/document">Docs</a><a class="navbar__item navbar__link" href="/community/contributor-guide">Community</a><a class="navbar__item navbar__link" href="/team">Team</a><a class="navbar__item navbar__link" href="/event">Event</a><a class="navbar__item navbar__link" href="/news">News</a><a class="navbar__item navbar__link" href="/blog">Blog</a><a class="navbar__item navbar__link" href="/users">Users</a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">ASF</a><ul class="dropdown__menu"><li><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Foundation</a></li><li><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="dropdown__link">License</a></li><li><a href="https://www.apache.org/events/current-event" target="_blank" rel="noopener noreferrer" class="dropdown__link">Events</a></li><li><a href="https://www.apache.org/security/" target="_blank" rel="noopener noreferrer" class="dropdown__link">Security</a></li><li><a href="https://www.apache.org/foundation/sponsorship.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Sponsorship</a></li><li><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Privacy</a></li><li><a href="https://www.apache.org/foundation/thanks.html" target="_blank" rel="noopener noreferrer" class="dropdown__link">Thanks</a></li></ul></div><a href="https://github.com/apache/shenyu" target="_blank" rel="noopener noreferrer" class="navbar__item navbar__link">GitHub<svg width="13.5" height="13.5" aria-label="(opens in new tab)" class="iconExternalLink_nPIU"><use href="#theme-svg-external-link"></use></svg></a><div class="navbar__item dropdown dropdown--hoverable dropdown--right"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link"><svg viewBox="0 0 24 24" width="20" height="20" aria-hidden="true" class="iconLanguage_nlXk"><path fill="currentColor" d="M12.87 15.07l-2.54-2.51.03-.03c1.74-1.94 2.98-4.17 3.71-6.53H17V4h-7V2H8v2H1v1.99h11.17C11.5 7.92 10.44 9.75 9 11.35 8.07 10.32 7.3 9.19 6.69 8h-2c.73 1.63 1.73 3.17 2.98 4.56l-5.09 5.02L4 19l5-5 3.11 3.11.76-2.04zM18.5 10h-2L12 22h2l1.12-3h4.75L21 22h2l-4.5-12zm-2.62 7l1.62-4.33L19.12 17h-3.24z"></path></svg>English</a><ul class="dropdown__menu"><li><a href="/docs/plugin-center/http-process/contextpath-plugin" target="_self" rel="noopener noreferrer" class="dropdown__link dropdown__link--active" lang="en">English</a></li><li><a href="/zh/docs/plugin-center/http-process/contextpath-plugin" target="_self" rel="noopener noreferrer" class="dropdown__link" lang="zh">简体中文</a></li></ul></div><div class="toggle_vylO colorModeToggle_DEke"><button class="clean-btn toggleButton_gllP toggleButtonDisabled_aARS" type="button" disabled="" title="system mode" aria-label="Switch between dark and light mode (currently system mode)"><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP lightToggleIcon_pyhR"><path fill="currentColor" d="M12,9c1.65,0,3,1.35,3,3s-1.35,3-3,3s-3-1.35-3-3S10.35,9,12,9 M12,7c-2.76,0-5,2.24-5,5s2.24,5,5,5s5-2.24,5-5 S14.76,7,12,7L12,7z M2,13l2,0c0.55,0,1-0.45,1-1s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S1.45,13,2,13z M20,13l2,0c0.55,0,1-0.45,1-1 s-0.45-1-1-1l-2,0c-0.55,0-1,0.45-1,1S19.45,13,20,13z M11,2v2c0,0.55,0.45,1,1,1s1-0.45,1-1V2c0-0.55-0.45-1-1-1S11,1.45,11,2z M11,20v2c0,0.55,0.45,1,1,1s1-0.45,1-1v-2c0-0.55-0.45-1-1-1C11.45,19,11,19.45,11,20z M5.99,4.58c-0.39-0.39-1.03-0.39-1.41,0 c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0s0.39-1.03,0-1.41L5.99,4.58z M18.36,16.95 c-0.39-0.39-1.03-0.39-1.41,0c-0.39,0.39-0.39,1.03,0,1.41l1.06,1.06c0.39,0.39,1.03,0.39,1.41,0c0.39-0.39,0.39-1.03,0-1.41 L18.36,16.95z M19.42,5.99c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06c-0.39,0.39-0.39,1.03,0,1.41 s1.03,0.39,1.41,0L19.42,5.99z M7.05,18.36c0.39-0.39,0.39-1.03,0-1.41c-0.39-0.39-1.03-0.39-1.41,0l-1.06,1.06 c-0.39,0.39-0.39,1.03,0,1.41s1.03,0.39,1.41,0L7.05,18.36z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP darkToggleIcon_wfgR"><path fill="currentColor" d="M9.37,5.51C9.19,6.15,9.1,6.82,9.1,7.5c0,4.08,3.32,7.4,7.4,7.4c0.68,0,1.35-0.09,1.99-0.27C17.45,17.19,14.93,19,12,19 c-3.86,0-7-3.14-7-7C5,9.07,6.81,6.55,9.37,5.51z M12,3c-4.97,0-9,4.03-9,9s4.03,9,9,9s9-4.03,9-9c0-0.46-0.04-0.92-0.1-1.36 c-0.98,1.37-2.58,2.26-4.4,2.26c-2.98,0-5.4-2.42-5.4-5.4c0-1.81,0.89-3.42,2.26-4.4C12.92,3.04,12.46,3,12,3L12,3z"></path></svg><svg viewBox="0 0 24 24" width="24" height="24" aria-hidden="true" class="toggleIcon_g3eP systemToggleIcon_QzmC"><path fill="currentColor" d="m12 21c4.971 0 9-4.029 9-9s-4.029-9-9-9-9 4.029-9 9 4.029 9 9 9zm4.95-13.95c1.313 1.313 2.05 3.093 2.05 4.95s-0.738 3.637-2.05 4.95c-1.313 1.313-3.093 2.05-4.95 2.05v-14c1.857 0 3.637 0.737 4.95 2.05z"></path></svg></button></div><div class="navbarSearchContainer_Bca1"><div class="navbar__search searchBarContainer_NW3z" dir="ltr"><input placeholder="Search" aria-label="Search" class="navbar__search-input" value=""><div class="loadingRing_RJI3 searchBarLoadingRing_YnHq"><div></div><div></div><div></div><div></div></div></div></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="__docusaurus_skipToContent_fallback" class="theme-layout-main main-wrapper mainWrapper_z2l0"><div class="docsWrapper_hBAB"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docRoot_UBD9"><aside class="theme-doc-sidebar-container docSidebarContainer_YfHR"><div class="sidebarViewport_aRkj"><div class="sidebar_njMd"><nav aria-label="Docs sidebar" class="menu thin-scrollbar menu_SIkG"><ul class="theme-doc-sidebar-menu menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/"><span title="Overview" class="linkLabel_WmDU">Overview</span></a></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/design/database-design"><span title="Design" class="categoryLinkLabel_W154">Design</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/deployment/deployment-before"><span title="Deployment" class="categoryLinkLabel_W154">Deployment</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/quick-start/quick-start-dubbo"><span title="Quick Start" class="categoryLinkLabel_W154">Quick Start</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/user-guide/admin-usage/api-document"><span title="User Guide" class="categoryLinkLabel_W154">User Guide</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" href="/docs/plugin-center/http-process/contextpath-plugin"><span title="Plugin Center" class="categoryLinkLabel_W154">Plugin Center</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret menu__link--active" role="button" aria-expanded="true" tabindex="0" href="/docs/plugin-center/http-process/contextpath-plugin"><span title="Http Process" class="categoryLinkLabel_W154">Http Process</span></a></div><ul class="menu__list"><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link menu__link--active" aria-current="page" tabindex="0" href="/docs/plugin-center/http-process/contextpath-plugin"><span title="ContextPath Plugin" class="linkLabel_WmDU">ContextPath Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/http-process/modifyresponse-plugin"><span title="ModifyResponse Plugin" class="linkLabel_WmDU">ModifyResponse Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/http-process/parammapping-plugin"><span title="ParamMapping Plugin" class="linkLabel_WmDU">ParamMapping Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/http-process/redirect-plugin"><span title="Redirect Plugin" class="linkLabel_WmDU">Redirect Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/http-process/request-plugin"><span title="Request Plugin" class="linkLabel_WmDU">Request Plugin</span></a></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-3 menu__list-item"><a class="menu__link" tabindex="0" href="/docs/plugin-center/http-process/rewrite-plugin"><span title="Rewrite Plugin" class="linkLabel_WmDU">Rewrite Plugin</span></a></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/proxy/divide-plugin"><span title="Proxy" class="categoryLinkLabel_W154">Proxy</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/fault-tolerance/hystrix-plugin"><span title="Fault Tolerance" class="categoryLinkLabel_W154">Fault Tolerance</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/security/casdoor"><span title="Security" class="categoryLinkLabel_W154">Security</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/observability/logging-aliyun-sls"><span title="Observability" class="categoryLinkLabel_W154">Observability</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/common/general-context-plugin"><span title="Common" class="categoryLinkLabel_W154">Common</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/cache/cache-plugin"><span title="Cache" class="categoryLinkLabel_W154">Cache</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/mock/mock-plugin"><span title="Mock" class="categoryLinkLabel_W154">Mock</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/ai/ai-prompt"><span title="Ai" class="categoryLinkLabel_W154">Ai</span></a></div></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-2 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" tabindex="0" href="/docs/plugin-center/mcp/mcp-server-plugin"><span title="Mcp" class="categoryLinkLabel_W154">Mcp</span></a></div></li></ul></li><li class="theme-doc-sidebar-item-category theme-doc-sidebar-item-category-level-1 menu__list-item menu__list-item--collapsed"><div class="menu__list-item-collapsible"><a class="categoryLink_byQd menu__link menu__link--sublist menu__link--sublist-caret" role="button" aria-expanded="false" href="/docs/developer/spi/custom-load-balance"><span title="Developer" class="categoryLinkLabel_W154">Developer</span></a></div></li><li class="theme-doc-sidebar-item-link theme-doc-sidebar-item-link-level-1 menu__list-item"><a class="menu__link" href="/docs/benchmark-test/"><span title="Benchmark Test" class="linkLabel_WmDU">Benchmark Test</span></a></li></ul></nav></div></div></aside><main class="docMainContainer_TBSr"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><nav class="theme-doc-breadcrumbs breadcrumbsContainer_Z_bl" aria-label="Breadcrumbs"><ul class="breadcrumbs"><li class="breadcrumbs__item"><a aria-label="Home page" class="breadcrumbs__link" href="/"><svg viewBox="0 0 24 24" class="breadcrumbHomeIcon_YNFT"><path d="M10 19v-5h4v5c0 .55.45 1 1 1h3c.55 0 1-.45 1-1v-7h1.7c.46 0 .68-.57.33-.87L12.67 3.6c-.38-.34-.96-.34-1.34 0l-8.36 7.53c-.34.3-.13.87.33.87H5v7c0 .55.45 1 1 1h3c.55 0 1-.45 1-1z" fill="currentColor"></path></svg></a></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Plugin Center</span></li><li class="breadcrumbs__item"><span class="breadcrumbs__link">Http Process</span></li><li class="breadcrumbs__item breadcrumbs__item--active"><span class="breadcrumbs__link">ContextPath Plugin</span></li></ul></nav><span class="theme-doc-version-badge badge badge--secondary">Version: 2.7.0.3</span><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>1. Overview</h1></header> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="11-plugin-name">1.1 Plugin Name<a href="#11-plugin-name" class="hash-link" aria-label="Direct link to 1.1 Plugin Name" title="Direct link to 1.1 Plugin Name" translate="no"></a></h2> |
| <ul> |
| <li class="">ContextPath Plugin</li> |
| </ul> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="12-appropriate-scenario">1.2 Appropriate Scenario<a href="#12-appropriate-scenario" class="hash-link" aria-label="Direct link to 1.2 Appropriate Scenario" title="Direct link to 1.2 Appropriate Scenario" translate="no"></a></h2> |
| <ul> |
| <li class="">Different services can do traffic governance of services by setting different context paths.</li> |
| </ul> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="13-plugin-functionality">1.3 Plugin functionality<a href="#13-plugin-functionality" class="hash-link" aria-label="Direct link to 1.3 Plugin functionality" title="Direct link to 1.3 Plugin functionality" translate="no"></a></h2> |
| <ul> |
| <li class="">Set the context path for service.</li> |
| <li class="">When the interface is called, the plug-in uniformly prefixes the interface address of the service.</li> |
| </ul> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="14-plugin-code">1.4 Plugin Code<a href="#14-plugin-code" class="hash-link" aria-label="Direct link to 1.4 Plugin Code" title="Direct link to 1.4 Plugin Code" translate="no"></a></h2> |
| <ul> |
| <li class="">Core module <code>shenyu-plugin-context-path</code></li> |
| <li class="">Core class <code>org.apache.shenyu.plugin.context.path.ContextPathPlugin</code></li> |
| </ul> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="15-added-since-which-shenyu-version">1.5 Added since which shenyu version<a href="#15-added-since-which-shenyu-version" class="hash-link" aria-label="Direct link to 1.5 Added since which shenyu version" title="Direct link to 1.5 Added since which shenyu version" translate="no"></a></h2> |
| <ul> |
| <li class="">2.3.0</li> |
| </ul> |
| <h1>2. How to use plugin</h1> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="21-plugin-use-procedure-chart">2.1 Plugin-use procedure chart<a href="#21-plugin-use-procedure-chart" class="hash-link" aria-label="Direct link to 2.1 Plugin-use procedure chart" title="Direct link to 2.1 Plugin-use procedure chart" translate="no"></a></h2> |
| <p><img decoding="async" loading="lazy" src="/assets/images/procedure-en-1e938b19eab6ff11bd956e3e9641bc52.png" width="474" height="462" class="img_ev3q"></p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="22-import-pom">2.2 Import pom<a href="#22-import-pom" class="hash-link" aria-label="Direct link to 2.2 Import pom" title="Direct link to 2.2 Import pom" translate="no"></a></h2> |
| <ul> |
| <li class="">import maven config in shenyu-bootstrap project's <code>pom.xml</code> file.</li> |
| </ul> |
| <div class="language-xml codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#393A34;--prism-background-color:#f6f8fa"><div class="codeBlockContent_QJqH"><pre tabindex="0" class="prism-code language-xml codeBlock_bY9V thin-scrollbar" style="color:#393A34;background-color:#f6f8fa"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">dependency</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">groupId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain">org.apache.shenyu</span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">groupId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">artifactId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain">shenyu-spring-boot-starter-gateway</span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">artifactId</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"><</span><span class="token tag" style="color:#00009f">version</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain">${project.version}</span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">version</span><span class="token tag punctuation" style="color:#393A34">></span><span class="token plain"></span><br></span><span class="token-line" style="color:#393A34"><span class="token plain"> </span><span class="token tag punctuation" style="color:#393A34"></</span><span class="token tag" style="color:#00009f">dependency</span><span class="token tag punctuation" style="color:#393A34">></span><br></span></code></pre></div></div> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="23-enable-plugin">2.3 Enable plugin<a href="#23-enable-plugin" class="hash-link" aria-label="Direct link to 2.3 Enable plugin" title="Direct link to 2.3 Enable plugin" translate="no"></a></h2> |
| <ul> |
| <li class="">In <code>shenyu-admin</code> --> BasicConfig --> Plugin --> <code>contextPath</code> set Status enable.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/enable-en-93474e3fbe53b33a7870f7cc5a2990e6.png" width="1910" height="664" class="img_ev3q"></p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="24-config-plugin">2.4 Config plugin<a href="#24-config-plugin" class="hash-link" aria-label="Direct link to 2.4 Config plugin" title="Direct link to 2.4 Config plugin" translate="no"></a></h2> |
| <ul> |
| <li class="">Set client project's contextPath.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/client-project-config-1b8ee987a5aaf08a17499f11a013f548.png" width="2794" height="1288" class="img_ev3q"></p> |
| <ul> |
| <li class="">Selector and rule config, please refer: <a class="" href="/docs/user-guide/admin-usage/selector-and-rule">Selector and rule config</a>.</li> |
| <li class="">shenyu-admin contextPath plugin config, config contextPath and addPrefix, contextPath defines the value of contextPath,</li> |
| <li class="">and addPrefix defines the prefix that needs to be automatically added when the interface is called.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/plugin-config-en-eb907beb602715d69ffe2df9e66b66ce.png" width="1906" height="767" class="img_ev3q"></p> |
| <h2 class="anchor anchorTargetStickyNavbar_Vzrq" id="25-examples">2.5 Examples<a href="#25-examples" class="hash-link" aria-label="Direct link to 2.5 Examples" title="Direct link to 2.5 Examples" translate="no"></a></h2> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="251-example-set-service-context-path">2.5.1 Example set service context path<a href="#251-example-set-service-context-path" class="hash-link" aria-label="Direct link to 2.5.1 Example set service context path" title="Direct link to 2.5.1 Example set service context path" translate="no"></a></h3> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2511-refer-local-deployment-to-start-admin-and-bootstrap">2.5.1.1 Refer <a href="https://shenyu.apache.org/docs/deployment/deployment-local/" target="_blank" rel="noopener noreferrer" class="">Local Deployment</a> to start admin and bootstrap.<a href="#2511-refer-local-deployment-to-start-admin-and-bootstrap" class="hash-link" aria-label="Direct link to 2511-refer-local-deployment-to-start-admin-and-bootstrap" title="Direct link to 2511-refer-local-deployment-to-start-admin-and-bootstrap" translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2512-refer-22-to-import-pom-and-restart-bootstrap">2.5.1.2 Refer 2.2 to import pom and restart bootstrap.<a href="#2512-refer-22-to-import-pom-and-restart-bootstrap" class="hash-link" aria-label="Direct link to 2.5.1.2 Refer 2.2 to import pom and restart bootstrap." title="Direct link to 2.5.1.2 Refer 2.2 to import pom and restart bootstrap." translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2513-refer-23-to-enable-plugin">2.5.1.3 Refer 2.3 to enable plugin.<a href="#2513-refer-23-to-enable-plugin" class="hash-link" aria-label="Direct link to 2.5.1.3 Refer 2.3 to enable plugin." title="Direct link to 2.5.1.3 Refer 2.3 to enable plugin." translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2514-client-project-config-contextpath">2.5.1.4 Client project config contextPath.<a href="#2514-client-project-config-contextpath" class="hash-link" aria-label="Direct link to 2.5.1.4 Client project config contextPath." title="Direct link to 2.5.1.4 Client project config contextPath." translate="no"></a></h4> |
| <p>Client project can directly use <a href="https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-http" target="_blank" rel="noopener noreferrer" class="">shenyu-examples-http</a>, and config contextPath in application.yml.</p> |
| <p><img decoding="async" loading="lazy" src="/assets/images/client-project-config-1b8ee987a5aaf08a17499f11a013f548.png" width="2794" height="1288" class="img_ev3q"></p> |
| <ul> |
| <li class="">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.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/context-path-selector-and-rule-en-73179545dae6c534b9dd2639949e1a57.png" width="1912" height="508" class="img_ev3q"></p> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2515-call-interface">2.5.1.5 Call Interface<a href="#2515-call-interface" class="hash-link" aria-label="Direct link to 2.5.1.5 Call Interface" title="Direct link to 2.5.1.5 Call Interface" translate="no"></a></h4> |
| <p><img decoding="async" loading="lazy" src="/assets/images/invoke-interface-cde95ab27ebf6f7608fcfe075e5245f7.png" width="2232" height="1682" class="img_ev3q"></p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="252-example-add-prefix">2.5.2 Example add prefix<a href="#252-example-add-prefix" class="hash-link" aria-label="Direct link to 2.5.2 Example add prefix" title="Direct link to 2.5.2 Example add prefix" translate="no"></a></h3> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2521-refer-local-deployment-to-start-admin-and-bootstrap">2.5.2.1 Refer <a href="https://shenyu.apache.org/docs/deployment/deployment-local/" target="_blank" rel="noopener noreferrer" class="">Local Deployment</a> to start admin and bootstrap.<a href="#2521-refer-local-deployment-to-start-admin-and-bootstrap" class="hash-link" aria-label="Direct link to 2521-refer-local-deployment-to-start-admin-and-bootstrap" title="Direct link to 2521-refer-local-deployment-to-start-admin-and-bootstrap" translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2522-refer-22-to-import-pom-and-restart-bootstrap">2.5.2.2 Refer 2.2 to import pom and restart bootstrap.<a href="#2522-refer-22-to-import-pom-and-restart-bootstrap" class="hash-link" aria-label="Direct link to 2.5.2.2 Refer 2.2 to import pom and restart bootstrap." title="Direct link to 2.5.2.2 Refer 2.2 to import pom and restart bootstrap." translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2523-refer-23-to-enable-plugin">2.5.2.3 Refer 2.3 to enable plugin.<a href="#2523-refer-23-to-enable-plugin" class="hash-link" aria-label="Direct link to 2.5.2.3 Refer 2.3 to enable plugin." title="Direct link to 2.5.2.3 Refer 2.3 to enable plugin." translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2524-client-project-config-contextpath">2.5.2.4 Client project config contextPath.<a href="#2524-client-project-config-contextpath" class="hash-link" aria-label="Direct link to 2.5.2.4 Client project config contextPath." title="Direct link to 2.5.2.4 Client project config contextPath." translate="no"></a></h4> |
| <p>For client project we can directly use <a href="https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-http" target="_blank" rel="noopener noreferrer" class="">shenyu-examples-http</a>, and config contextPath in application.yml.</p> |
| <p><img decoding="async" loading="lazy" src="/assets/images/client-project-config-1b8ee987a5aaf08a17499f11a013f548.png" width="2794" height="1288" class="img_ev3q"></p> |
| <ul> |
| <li class="">After the configuration is completed, start client project, you can see that there is an additional context selector and rule configuration in shenyu-admin.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/context-path-selector-and-rule-en-73179545dae6c534b9dd2639949e1a57.png" width="1912" height="508" class="img_ev3q"></p> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2525-config-addprefix">2.5.2.5 Config addPrefix<a href="#2525-config-addprefix" class="hash-link" aria-label="Direct link to 2.5.2.5 Config addPrefix" title="Direct link to 2.5.2.5 Config addPrefix" translate="no"></a></h4> |
| <p><img decoding="async" loading="lazy" src="/assets/images/add-prefix-en-a804086aec06625788372c6a3933ff32.png" width="1906" height="768" class="img_ev3q"></p> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2526-modify-the-value-of-uri-in-the-selector-and-condition-configuration-to-delete-the-addprefix-part">2.5.2.6 Modify the value of uri in the selector and condition configuration to delete the addPrefix part.<a href="#2526-modify-the-value-of-uri-in-the-selector-and-condition-configuration-to-delete-the-addprefix-part" class="hash-link" aria-label="Direct link to 2.5.2.6 Modify the value of uri in the selector and condition configuration to delete the addPrefix part." title="Direct link to 2.5.2.6 Modify the value of uri in the selector and condition configuration to delete the addPrefix part." translate="no"></a></h4> |
| <p>Since this example uses the service of the http protocol, we need to modify the divide plugin.</p> |
| <p><img decoding="async" loading="lazy" src="/assets/images/remove-add-prefix-en-9c8f7b7d266761d4ceb0f3ca720a5928.png" width="1895" height="817" class="img_ev3q"></p> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2527-call-interface">2.5.2.7 Call Interface<a href="#2527-call-interface" class="hash-link" aria-label="Direct link to 2.5.2.7 Call Interface" title="Direct link to 2.5.2.7 Call Interface" translate="no"></a></h4> |
| <p><img decoding="async" loading="lazy" src="/assets/images/invoke-interface-add-prefix-51c6dfad10bf466ae61d0bfc507a7443.png" width="2880" height="1668" class="img_ev3q"></p> |
| <h3 class="anchor anchorTargetStickyNavbar_Vzrq" id="253-example-rewrite-application">2.5.3 Example rewrite application<a href="#253-example-rewrite-application" class="hash-link" aria-label="Direct link to 2.5.3 Example rewrite application" title="Direct link to 2.5.3 Example rewrite application" translate="no"></a></h3> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2531-refer-local-deployment-to-start-admin-and-bootstrap">2.5.3.1 Refer <a href="https://shenyu.apache.org/docs/deployment/deployment-local/" target="_blank" rel="noopener noreferrer" class="">Local Deployment</a> to start admin and bootstrap.<a href="#2531-refer-local-deployment-to-start-admin-and-bootstrap" class="hash-link" aria-label="Direct link to 2531-refer-local-deployment-to-start-admin-and-bootstrap" title="Direct link to 2531-refer-local-deployment-to-start-admin-and-bootstrap" translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2532-refer-22-to-import-pom-and-restart-bootstrap">2.5.3.2 Refer 2.2 to import pom and restart bootstrap.<a href="#2532-refer-22-to-import-pom-and-restart-bootstrap" class="hash-link" aria-label="Direct link to 2.5.3.2 Refer 2.2 to import pom and restart bootstrap." title="Direct link to 2.5.3.2 Refer 2.2 to import pom and restart bootstrap." translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2533-refer-23-to-enable-plugin">2.5.3.3 Refer 2.3 to enable plugin.<a href="#2533-refer-23-to-enable-plugin" class="hash-link" aria-label="Direct link to 2.5.3.3 Refer 2.3 to enable plugin." title="Direct link to 2.5.3.3 Refer 2.3 to enable plugin." translate="no"></a></h4> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2534-run-client-projects">2.5.3.4 Run client projects.<a href="#2534-run-client-projects" class="hash-link" aria-label="Direct link to 2.5.3.4 Run client projects." title="Direct link to 2.5.3.4 Run client projects." translate="no"></a></h4> |
| <p>For client project we can directly use <a href="https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-http" target="_blank" rel="noopener noreferrer" class="">shenyu-examples-http</a> and <a href="https://github.com/apache/shenyu/tree/master/shenyu-examples/shenyu-examples-https" target="_blank" rel="noopener noreferrer" class="">shenyu-examples-https</a>.</p> |
| <ul> |
| <li class="">After the client projects started, you can see that there are two additional context selectors and rules configuration in shenyu-admin.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/context-path-selectors-9f0e881bd1af70c10089bbcbbc5665cb.jpg" width="3414" height="1386" class="img_ev3q"></p> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2535-config-rewritecontextpath">2.5.3.5 Config rewriteContextPath<a href="#2535-config-rewritecontextpath" class="hash-link" aria-label="Direct link to 2.5.3.5 Config rewriteContextPath" title="Direct link to 2.5.3.5 Config rewriteContextPath" translate="no"></a></h4> |
| <p><img decoding="async" loading="lazy" src="/assets/images/rewrite-context-path-303dcab09c0e37b2a1cb8007dc4bcda7.jpg" width="2016" height="1412" class="img_ev3q"></p> |
| <p>Note: the percentage can adjust the rewriting ratio from 0 to 100, with a default of 100, indicating complete rewriting.</p> |
| <h4 class="anchor anchorTargetStickyNavbar_Vzrq" id="2526-call-interface">2.5.2.6 Call Interface<a href="#2526-call-interface" class="hash-link" aria-label="Direct link to 2.5.2.6 Call Interface" title="Direct link to 2.5.2.6 Call Interface" translate="no"></a></h4> |
| <p><img decoding="async" loading="lazy" src="/assets/images/invoke-interface-rewrite-context-path-2e805aabd6653039e16345f93e1d54a6.jpg" width="3364" height="1858" class="img_ev3q"></p> |
| <h1>3. How to disable plugin</h1> |
| <ul> |
| <li class="">In <code>shenyu-admin</code> --> BasicConfig --> Plugin --> <code>contextPath</code> set Status disable.</li> |
| </ul> |
| <p><img decoding="async" loading="lazy" src="/assets/images/disable-en-e92e23f9495300ceabd7f3937970e5db.png" width="1912" height="682" class="img_ev3q"></p></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="row margin-top--sm theme-doc-footer-edit-meta-row"><div class="col noPrint_WFHX"><a href="https://github.com/apache/shenyu-website/edit/main/versioned_docs/version-2.7.0.3/plugin-center/http-process/contextpath-plugin.md" target="_blank" rel="noopener noreferrer" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_JAkA"></div></div></footer></article><nav class="docusaurus-mt-lg pagination-nav" aria-label="Docs pages"><a class="pagination-nav__link pagination-nav__link--prev" href="/docs/user-guide/api-doc/swagger-apidoc"><div class="pagination-nav__sublabel">Previous</div><div class="pagination-nav__label">Pull the swagger registration API document</div></a><a class="pagination-nav__link pagination-nav__link--next" href="/docs/plugin-center/http-process/modifyresponse-plugin"><div class="pagination-nav__sublabel">Next</div><div class="pagination-nav__label">ModifyResponse Plugin</div></a></nav></div></div><div class="col col--3"><div class="tableOfContents_bqdL thin-scrollbar theme-doc-toc-desktop"><ul class="table-of-contents table-of-contents__left-border"><li><a href="#11-plugin-name" class="table-of-contents__link toc-highlight">1.1 Plugin Name</a></li><li><a href="#12-appropriate-scenario" class="table-of-contents__link toc-highlight">1.2 Appropriate Scenario</a></li><li><a href="#13-plugin-functionality" class="table-of-contents__link toc-highlight">1.3 Plugin functionality</a></li><li><a href="#14-plugin-code" class="table-of-contents__link toc-highlight">1.4 Plugin Code</a></li><li><a href="#15-added-since-which-shenyu-version" class="table-of-contents__link toc-highlight">1.5 Added since which shenyu version</a></li><li><a href="#21-plugin-use-procedure-chart" class="table-of-contents__link toc-highlight">2.1 Plugin-use procedure chart</a></li><li><a href="#22-import-pom" class="table-of-contents__link toc-highlight">2.2 Import pom</a></li><li><a href="#23-enable-plugin" class="table-of-contents__link toc-highlight">2.3 Enable plugin</a></li><li><a href="#24-config-plugin" class="table-of-contents__link toc-highlight">2.4 Config plugin</a></li><li><a href="#25-examples" class="table-of-contents__link toc-highlight">2.5 Examples</a><ul><li><a href="#251-example-set-service-context-path" class="table-of-contents__link toc-highlight">2.5.1 Example set service context path</a></li><li><a href="#252-example-add-prefix" class="table-of-contents__link toc-highlight">2.5.2 Example add prefix</a></li><li><a href="#253-example-rewrite-application" class="table-of-contents__link toc-highlight">2.5.3 Example rewrite application</a></li></ul></li></ul></div></div></div></div></main></div></div></div></div> |
| </body> |
| </html> |
