Files
fizz-gateway-node/docs/guide/manager/manager_api_auth.html
Francis Dong 8b2ee7276b update doc
2020-12-03 16:26:00 +08:00

38 lines
17 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>路由管理 | Fizz Gateway</title>
<meta name="generator" content="VuePress 1.5.2">
<meta name="description" content="">
<link rel="preload" href="/assets/css/0.styles.1a4b7b81.css" as="style"><link rel="preload" href="/assets/js/app.efb450d4.js" as="script"><link rel="preload" href="/assets/js/2.60c09e20.js" as="script"><link rel="preload" href="/assets/js/19.14c3cafc.js" as="script"><link rel="prefetch" href="/assets/js/10.3c989e54.js"><link rel="prefetch" href="/assets/js/11.a76c2e4c.js"><link rel="prefetch" href="/assets/js/12.9b8b7937.js"><link rel="prefetch" href="/assets/js/13.52740b54.js"><link rel="prefetch" href="/assets/js/14.27ba8a23.js"><link rel="prefetch" href="/assets/js/15.791d6b9d.js"><link rel="prefetch" href="/assets/js/16.c487dae0.js"><link rel="prefetch" href="/assets/js/17.65f826a9.js"><link rel="prefetch" href="/assets/js/18.603a235b.js"><link rel="prefetch" href="/assets/js/20.b646f0b0.js"><link rel="prefetch" href="/assets/js/21.081e4e30.js"><link rel="prefetch" href="/assets/js/22.ddeb9465.js"><link rel="prefetch" href="/assets/js/23.f1118a32.js"><link rel="prefetch" href="/assets/js/24.72fe0b8b.js"><link rel="prefetch" href="/assets/js/25.bbf8bff1.js"><link rel="prefetch" href="/assets/js/26.92e9b6ec.js"><link rel="prefetch" href="/assets/js/27.505a813e.js"><link rel="prefetch" href="/assets/js/28.cdddd7aa.js"><link rel="prefetch" href="/assets/js/29.ab810898.js"><link rel="prefetch" href="/assets/js/3.c3fe6d17.js"><link rel="prefetch" href="/assets/js/30.0222f21c.js"><link rel="prefetch" href="/assets/js/31.0012b621.js"><link rel="prefetch" href="/assets/js/4.9e51e17c.js"><link rel="prefetch" href="/assets/js/5.ddeac0a1.js"><link rel="prefetch" href="/assets/js/6.e883523c.js"><link rel="prefetch" href="/assets/js/7.00dd2642.js"><link rel="prefetch" href="/assets/js/8.b37e0826.js"><link rel="prefetch" href="/assets/js/9.88cc55c9.js">
<link rel="stylesheet" href="/assets/css/0.styles.1a4b7b81.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" class="home-link router-link-active"><!----> <span class="site-name">Fizz Gateway</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/" class="nav-link">
首页
</a></div><div class="nav-item"><a href="/guide/intro/" class="nav-link">
使用文档
</a></div> <a href="https://github.com/wehotel/fizz-gateway-community" target="_blank" rel="noopener noreferrer" class="repo-link">
查看源码
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/" class="nav-link">
首页
</a></div><div class="nav-item"><a href="/guide/intro/" class="nav-link">
使用文档
</a></div> <a href="https://github.com/wehotel/fizz-gateway-community" target="_blank" rel="noopener noreferrer" class="repo-link">
查看源码
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav> <ul class="sidebar-links"><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Fizz简介</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/intro/" class="sidebar-link">什么是Fizz网关</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/intro/#什么是fizz网关" class="sidebar-link">什么是Fizz网关</a></li><li class="sidebar-sub-header"><a href="/guide/intro/#fizz的设计" class="sidebar-link">Fizz的设计</a></li><li class="sidebar-sub-header"><a href="/guide/intro/#产品特性" class="sidebar-link">产品特性</a></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>安装部署</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/installation/" class="sidebar-link">安装</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/installation/#安装依赖" class="sidebar-link">安装依赖</a></li><li class="sidebar-sub-header"><a href="/guide/installation/#安装fizz" class="sidebar-link">安装Fizz</a></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>路由转发</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/proxy/" class="sidebar-link">路由转发</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/proxy/#路由转发介绍" class="sidebar-link">路由转发介绍</a></li><li class="sidebar-sub-header"><a href="/guide/proxy/#接入路由转发" class="sidebar-link">接入路由转发</a></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>服务编排</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/aggregate/" class="sidebar-link">服务编排介绍</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/aggregate/#什么是服务编排" class="sidebar-link">什么是服务编排</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/#举例说明" class="sidebar-link">举例说明</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/#服务编排架构" class="sidebar-link">服务编排架构</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/#适用场景" class="sidebar-link">适用场景</a></li></ul></li><li><a href="/guide/aggregate/overview.html" class="sidebar-link">步骤总览</a></li><li><a href="/guide/aggregate/configuration.html" class="sidebar-link">服务编排配置</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#创建服务" class="sidebar-link">创建服务</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#创建聚合接口" class="sidebar-link">创建聚合接口</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#配置输入" class="sidebar-link">配置输入</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#配置校验结果" class="sidebar-link">配置校验结果</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#配置步骤" class="sidebar-link">配置步骤</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#配置输出" class="sidebar-link">配置输出</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#脚本-2" class="sidebar-link">脚本</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#抛出异常" class="sidebar-link">抛出异常</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#重定向" class="sidebar-link">重定向</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#配置路由" class="sidebar-link">配置路由</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#在线测试" class="sidebar-link">在线测试</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#脚本执行异常" class="sidebar-link">脚本执行异常</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#导入导出" class="sidebar-link">导入导出</a></li><li class="sidebar-sub-header"><a href="/guide/aggregate/configuration.html#发布-下线和审核" class="sidebar-link">发布|下线和审核</a></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>插件机制</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/plugin/" class="sidebar-link">插件开发</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/plugin/#概述" class="sidebar-link">概述</a></li><li class="sidebar-sub-header"><a href="/guide/plugin/#gateway开发" class="sidebar-link">gateway开发</a></li><li class="sidebar-sub-header"><a href="/guide/plugin/#manager配置" class="sidebar-link">manager配置</a></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>基准测试</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/benchmark/" class="sidebar-link">benchmark</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/benchmark/#基准测试结果" class="sidebar-link">基准测试结果</a></li><li class="sidebar-sub-header"><a href="/guide/benchmark/#基准测试详情" class="sidebar-link">基准测试详情</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/benchmark/#硬件环境" class="sidebar-link">硬件环境</a></li><li class="sidebar-sub-header"><a href="/guide/benchmark/#压测工具" class="sidebar-link">压测工具</a></li><li class="sidebar-sub-header"><a href="/guide/benchmark/#压测结果截图" class="sidebar-link">压测结果截图</a></li></ul></li></ul></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading open"><span>管理后台</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/manager/manager_overview.html" class="sidebar-link">管理后台简介</a></li><li><a href="/guide/manager/manager_gateway_group.html" class="sidebar-link">网关分组</a></li><li><a href="/guide/manager/manager_plugin.html" class="sidebar-link">插件管理</a></li><li><a href="/guide/manager/manager_app_id.html" class="sidebar-link">appID管理</a></li><li><a href="/guide/manager/manager_api_auth.html" aria-current="page" class="active sidebar-link">路由管理</a></li><li><a href="/guide/manager/manager_service.html" class="sidebar-link">服务管理</a></li><li><a href="/guide/manager/manager_aggregate.html" class="sidebar-link">接口列表</a></li><li><a href="/guide/manager/manager_aggregate_op_log.html" class="sidebar-link">操作日志</a></li><li><a href="/guide/manager/manager_gateway_aggregate_cache.html" class="sidebar-link">网关缓存</a></li><li><a href="/guide/manager/manager_aggregate_my_apply.html" class="sidebar-link">我的申请</a></li><li><a href="/guide/manager/manager_aggregate_approve.html" class="sidebar-link">待审核</a></li><li><a href="/guide/manager/manager_aggregate_approve_op_log.html" class="sidebar-link">审核日志</a></li><li><a href="/guide/manager/manager_role.html" class="sidebar-link">角色管理</a></li><li><a href="/guide/manager/manager_user.html" class="sidebar-link">用户管理</a></li></ul></section></li><li><section class="sidebar-group depth-0"><p class="sidebar-heading"><span>Roadmap</span> <!----></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/guide/roadmap/" class="sidebar-link">Roadmap</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/roadmap/#v1-2-x" class="sidebar-link">v1.2.x</a></li><li class="sidebar-sub-header"><a href="/guide/roadmap/#v1-3-x" class="sidebar-link">v1.3.x</a></li><li class="sidebar-sub-header"><a href="/guide/roadmap/#v1-4-x" class="sidebar-link">v1.4.x</a></li><li class="sidebar-sub-header"><a href="/guide/roadmap/#v1-5-x" class="sidebar-link">v1.5.x</a></li><li class="sidebar-sub-header"><a href="/guide/roadmap/#v1-6-x" class="sidebar-link">v1.6.x</a></li></ul></li></ul></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h2 id="概述"><a href="#概述" class="header-anchor">#</a> 概述</h2> <p>路由管理功能用于维护网关的路由规则,支持按请求路径转发、转发到指定后端服务两种转发规则,支持插件配置。下面介绍路由管理的操作。</p> <h2 id="路由列表"><a href="#路由列表" class="header-anchor">#</a> 路由列表</h2> <p>菜单位置:网关管理 &gt; 路由管理。点击菜单后进入路由列表页面,如图所示。</p> <p><img src="/manager_api_auth_list_query.png" alt="manager_api_auth_list_query"></p> <h2 id="新增路由"><a href="#新增路由" class="header-anchor">#</a> 新增路由</h2> <p>点击 新增 按钮弹出新增窗口,如图所示。</p> <p><img src="/manager_api_auth_add_1.png" alt="manager_api_auth_add_1"></p> <p><img src="/manager_api_auth_add_2.png" alt="manager_api_auth_add_2"></p> <p>网关分组:选取路由关联的网关分组,只有属于所选分组的网关实例路由规则才会生效,必选;</p> <p>服务:网关的请求路径格式为 http://{ip}:{port}/proxy/{service}{apiPath},服务对应{service}段,当 转发 选择 按请求路径转发 时服务需要是聚合配置的服务或者是Eureka注册的服务当 转发 选择 转发到指定后端服务 时服务不需要是实际存在的服务只用于路径匹配使用长度不能超过50个字符必填</p> <p>API方法请求的method类型可选GET|POST</p> <p>API Path网关的请求路径格式为 http://{ip}:{port}/proxy/{service}{apiPath}API Path对应{apiPath}段,使用前缀匹配原则,例如&quot;/api/&quot;将匹配&quot;/api/&quot;&quot;/api/1&quot;&quot;/api/1/1&quot;等路径;</p> <p>应用选取路由关联的应用网关使用选取应用的信息进行鉴权更多详情请查看appID管理功能介绍</p> <p>访问:可选允许|禁止,必选;</p> <p>转发:可选按请求路径转发|转发到指定后端服务,当选择 按请求路径转发 时,请求会按请求路径转发,例如网关请求 http://{ip}:{port}/proxy/my-service/api-path 将转发到 http://my-service/api-path当选择 转发到指定后端服务 时需要添加转发到的后端服务URL请求会转发到配置的后端服务例如配置了服务为 my-serviceAPI Path为空后端服务URL为 http://127.0.0.1:8080/forward-service/,网关请求 http://{ip}:{port}/proxy/my-service/api-path 将转发到 http://127.0.0.1:8080/forward-service/api-path。</p> <p>点击 添加插件 按钮为路由添加插件,如图所示。</p> <p><img src="/manager_api_auth_add_3.png" alt="manager_api_auth_add_3"></p> <p>配置插件路由级别的自定义配置,表单界面来自于插件的表单定义,更多详情请查看插件管理功能介绍。</p> <p><img src="/manager_api_auth_add_4.png" alt="manager_api_auth_add_4"></p> <p>配置完成后点击 保存 按钮保存路由规则。</p> <p><img src="/manager_api_auth_add_5.png" alt="manager_api_auth_add_5"></p> <h2 id="编辑路由"><a href="#编辑路由" class="header-anchor">#</a> 编辑路由</h2> <p>点击 编辑 按钮弹出编辑窗口,如图所示。</p> <p><img src="/manager_api_auth_edit_1.png" alt="manager_api_auth_edit_1"></p> <p><img src="/manager_api_auth_edit_2.png" alt="manager_api_auth_edit_2"></p> <h2 id="删除路由"><a href="#删除路由" class="header-anchor">#</a> 删除路由</h2> <p>点击 删除 按钮弹出删除确认窗口,如图所示。</p> <p><img src="/manager_api_auth_delete_1.png" alt="manager_api_auth_delete_1"></p> <p><img src="/manager_api_auth_delete_2.png" alt="manager_api_auth_delete_2"></p></div> <footer class="page-edit"><!----> <div class="last-updated"><span class="prefix">上次更新:</span> <span class="time">2020-11-9 11:50</span></div></footer> <div class="page-nav"><p class="inner"><span class="prev">
<a href="/guide/manager/manager_app_id.html" class="prev">
appID管理
</a></span> <span class="next"><a href="/guide/manager/manager_service.html">
服务管理
</a>
</span></p></div> </main></div><div class="global-ui"></div></div>
<script src="/assets/js/app.efb450d4.js" defer></script><script src="/assets/js/2.60c09e20.js" defer></script><script src="/assets/js/19.14c3cafc.js" defer></script>
</body>
</html>