Gateway配置大全

Gateway配置大全

需求说明,由于要做gateway动态更新,但是配置文件都是json的方式进行编写,找了很多资料,最后发现一个很全的链接gateway配置大全,本着学习的态度,抄录一遍。

Predicates

Predicates主要起的作用是:配置路由匹配请求的规则

Http相关

Path

配置对于请求路径的匹配规则
  • yml配置,多个参数用逗号隔开
- Path = /aa/**,/bb/**
  • json配置
{"name":"Path","args":{"pattern":"/aa/**","pattern1":"/bb/**"}}

Cookie

配置对Cookie中值的匹配,第一个为key,第二个为value。下例匹配cookie设置chocolate:ch.p的请求
  • yml配置
- Cookie = chocolate,ch.p
  • json配置
{"name":"Cookie","args":{"_genkey_0":"chocolate","_genkey_1":"ch.p"}}

Header

匹配Http请求中设置的内容,http-header设置X-Request-Id:\d+可以匹配,第二个参数第二个参数是正则表达式
  • yml配置
- Header = X-Request-Id,\d+
  • json配置
{"name":"Header","args":{"_genkey_0":"X-Request-Id","_genkey_1":"\d+"}}

Host

匹配Http请求Host,匹配所有host为**.somehost.com的请求
  • yml配置
- Host = **.somehost.com
  • json配置
{"name":"Host","args":{"_genkey_0":"**.somehost.com"}}

Method

匹配Http请求头
  • yml配置
- Method = GET
  • json配置
{"name":"Method","args":{"_genkey_0":"GET"}}

Query

匹配Http请求中的查询参数,请求中携带param1=value的请求可以匹配
  • yml配置
- Query = param1,value
  • json配置
{"name":"Query","args":{"_genkey_0":"param1","_genkey_1":"value"}}

RemoteAddr

匹配请求中的RemoteAddr
  • yml配置
- RemoteAddr = 192.168.1.1/24
  • json配置
{"name":"RemoteAddr","args":{"_genkey_0":"192.168.1.1/24"}}

时间相关

After

设置时间之后可以访问
  • yml配置
- After = 2017-01-20T17:42:47.789-07:00[America/Denver]
  • json配置
{"name":"After","args":{"_genkey_0":"2017-01-20T17:42:47.789-07:00[America/Denver]"}}

Before

设置时间之前可以访问
  • yml配置
- Before = 2017-01-20T17:42:47.789-07:00[America/Denver]
  • json配置
{"name":"Before","args":{"_genkey_0":"2017-01-20T17:42:47.789-07:00[America/Denver]"}}

Before

设置时间段内可以访问
  • yml配置
- Between = 2017-01-20T17:42:47.789-07:00[America/Denver],2017-01-21T17:42:47.789-07:00[America/Denver]
  • json配置
{"name":"Between","args":{"_genkey_0":"2017-01-20T17:42:47.789-07:00[America/Denver]""_genkey_1":"2017-01-21T17:42:47.789-07:00[America/Denver]"}}

权重路由

至少两组以上路由可以配置权重路由,配置后会根据权重随机访问几个路由
  • yml配置
- Weight = service1,80

json配置

{"name":"Weight","args":{"_genkey_0":"service1","_genkey_1":"80"}}

Filters

路径重写

yml配置

- RewritePath = /path/(?<segment>.*), /$\{segment}
  • json配置
{"name":"RewritePath","args":{"_genkey_0":"/foo/(?<segment>.*)","_genkey_1":"/$\\{segment}"}}

修改请求头

yml配置

- AddRequestHeader = X-Request-Foo,Bar
  • json配置
{"name":"AddRequestHeader","args":{"_genkey_0":"X-Request-Foo","_genkey_1":"Bar"}}

修改请求参数

yml配置

- AddRequestParameter = foo,bar
  • json配置
{"name":"AddRequestParameter","args":{"_genkey_0":"foo","_genkey_1":"bar"}}

修改响应参数

yml配置

- AddResponseHeader = X-Request-Foo,Bar
  • json配置
{"name":"AddResponseHeader","args":{"_genkey_0":"X-Request-Foo","_genkey_1":"Bar"}}

路径前缀增强

请求路径/hello, 将会被替换为 /mypath/hello
  • yml配置
- PrefixPath = /mypath
  • json配置
{"name":"PrefixPath","args":{"_genkey_0":"/mypath"}}

路径前缀删除

请求/name/bar/foo,去除掉前面两个前缀之后,最后转发到目标服务的路径为/foo
  • yml配置
- StripPrefix = 2
  • json配置
{"name":"StripPrefix","args":{"_genkey_0":"2"}}

请求携带保留原始Host

  • yml配置
- PreserveHostHeader
  • json配置
{"name":"PreserveHostHeader","args":{}}

重定向

  • yml配置
- RedirectTo = 302,http://acme.org
  • json配置
{"name":"RedirectTo","args":{"_genkey_0":"302","_genkey_1":"http://acme.org"}}

断路器

  • yml配置
- name: Hystrix
  args:
	  # 断路后跳转地址
	  name: fallbackcmd
      fallbackUri: forward:/incaseoffailureusethis
  • json配置
{"name":"Hystrix","args":{"name":"fallbackcmd","fallbackUri":"forward:/incaseoffailureusethis"}}

集成Redis原生支持请求限流

  • yml配置
 - name: RequestRateLimiter
   args:
     redis-rate-limiter.replenishRate: 10  
     redis-rate-limiter.burstCapacity: 20
  • json配置
{"name":"RequestRateLimiter","args":{"redis-rate-limiter.replenishRate":"10","redis-rate-limiter.burstCapacity":"20"}}

删除请求头属性

  • yml配置
- RemoveRequestHeader = X-Request-Foo
  • json配置
{"name":"RemoveRequestHeader","args":{"_genkey_0":"X-Request-Foo"}}

删除响应头属性

  • yml配置
- RemoveResponseHeader = X-Request-Foo
  • json配置
{"name":"RemoveResponseHeader","args":{"_genkey_0":"X-Request-Foo"}}

重写响应头

将请求 /42?user=ford&password=omg!what&flag=true, 改为 /42?user=ford&password=***&flag=true
  • yml配置
- RewriteResponseHeader = X-Response-Foo,password=[^&]+,password=***
  • json配置
{"name":"RewriteResponseHeader","args":{"_genkey_0":"X-Response-Foo","_genkey_1":"password=[^&]+","_genkey_2":"password=***"}}

重设请求路径

请求/foo/bar,在接下来的处理中被改为/bar
  • yml配置
- SetPath =/{segment}
  • json配置
{"name":"SetPath","args":{"_genkey_0":"/{segment}"}}

设置响应头

在接下来的处理中修改响应头X-Response-Foo为Bar
  • yml配置
- SetResponseHeader =X-Request-Foo,Bar
  • json配置
{"name":"SetResponseHeader","args":{"_genkey_0":"X-Response-Foo","_genkey_1":"Bar"}}

设置Http状态

  • yml配置
- name: SetStatus
  args:
	  status: 401
  • json配置
{"name":"SetStatus","args":{"_genkey_0":"302"}}

设置文件传输大小

  • yml配置
 - name: RequestSize
   args:
	   maxSize: 5000000
  • json配置
{"name":"RequestSize","args":{"_genkey_0":"5000000"}}

失败重试

  • yml配置
- name: Retry
  args:
	  retries: 3
      statuses: BAD_GATEWAY
  • 8
    点赞
  • 18
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
要在gateway配置Swagger,需要进行以下步骤: 1. 添加Swagger依赖项 在pom.xml文件中添加以下依赖项: ``` <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version>2.2.3.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version>2.2.3.RELEASE</version> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version>2.2.3.RELEASE</version> <type>test-jar</type> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version>2.2.3.RELEASE</version> <type>test-jar</type> <classifier>tests</classifier> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-gateway</artifactId> <version>2.2.3.RELEASE</version> <classifier>tests</classifier> <scope>test</scope> </dependency> ``` 2. 创建Swagger配置类 创建一个Swagger配置类,并添加以下内容: ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 3. 注册Swagger路由 在application.yml文件中添加以下内容,以将Swagger路由到相应的URL: ``` spring: cloud: gateway: routes: - id: swagger uri: lb://swagger-ui predicates: - Path=/swagger/** ``` 4. 启动服务 启动服务并访问"http://localhost:8080/swagger-ui.html",即可查看Swagger API文档。 希望这些步骤可以帮助你配置Swagger到gateway中。
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值