looping.md

Looping

In tyk you target api's by tyk://<API_ID>/<path> scheme. this requires prior knowledge of the API_ID. Since the operator treats api's as objects and it manages them including assigning API_ID, we introduce a typed api to refer to other apis.

The operator will automatically generates the correct url before sending it to the gateway.

Full sample file

URL Rewriting

A rewrite_to_internal field is used to target other api resources.

rewrite_to_internal:
  description: RewriteToInternal defines options that constructs a url that refers to an api that is loaded into the gateway.
  properties:
    path:
      description: "Path path on target , this does not include query parameters. \texample /myendpoint"
      type: string
    query:
      description: "Query url query string to add to target \texample check_limits=true"
      type: string
    target:
      description: API a namespaced/name to the api definition resource that you are targetting
      properties:
        name:
          type: string
        namespace:
          type: string
      required:
      - name
      - namespace

usage

url_rewrites:
  - path: "/{id}"
    match_pattern: "/basic/(.*)"
    method: GET
    rewrite_to_internal:
      target:
        name: proxy-api
        namespace: default
      path: proxy/$1

This api is targeting an ApiDefinition resource proxy-api in default namespace. The operator will take care of transforming this into something like this

url_rewrites:
- match_pattern: /basic/(.*)
  method: GET
  path: /{id}
  rewrite_to: tyk://ZGVmYXVsdC9wcm94eS1hcGk/proxy/$1

URL Rewriting triggers

A rewrite_to_internal used to target other api resources in triggers. For example

triggers:
  - "on": "all"
    options:
      header_matches:
        "Authorization":
          match_rx: "^Basic"
    rewrite_to_internal:
      target:
        name: basic-auth-internal
        namespace: default
      path: "basic/$2"

The operator transform that into something like this

triggers:
- "on": all
  options:
    header_matches:
      Authorization:
        match_rx: ^Basic
  rewrite_to: tyk://ZGVmYXVsdC9iYXNpYy1hdXRoLWludGVybmFs/basic/$2

Proxy to internal apis

A target_internal field on proxy object is used to target other api resources. This field properties are the same as the ones described for rewrite_to_internal.