-
Notifications
You must be signed in to change notification settings - Fork 157
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DX-1008] Updated Internal Endpoint middleware (#4046)
* Updated Internal Endpoint ---------
- Loading branch information
Showing
10 changed files
with
254 additions
and
10 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+97 KB
tyk-docs/assets/img/dashboard/endpoint-designer/ignore-authentication.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+96.5 KB
tyk-docs/assets/img/dashboard/endpoint-designer/internal-endpoint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
58 changes: 58 additions & 0 deletions
58
...cs/content/product-stack/tyk-gateway/middleware/internal-endpoint-middleware.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,58 @@ | ||
| --- | ||
| title: Internal Endpoint middleware | ||
| date: 2024-01-26 | ||
| description: "Detail of the Internal Endpoint middleware" | ||
| tags: ["internal endpoint", "internal", "middleware", "per-endpoint"] | ||
| --- | ||
|
|
||
| The Internal Endpoint middleware instructs Tyk Gateway to ignore external requests to the endpoint (which is a combination of HTTP method and path). Internal requests from other APIs will be processed. | ||
|
|
||
| ## When to use the Internal Endpoint middleware | ||
| #### Internal routing decisions | ||
| Internal endpoints are frequently used to make complex routing decisions that cannot be handled by the standard routing features. A single externally published endpoint can receive requests and then, based on inspection of the requests, the [URL rewrite]({{< ref "transform-traffic/url-rewriting" >}}) middleware can route them to different internal endpoints and on to the appropriate upstream services. | ||
|
|
||
| ## How internal endpoints work | ||
| When the Internal Endpoint middleware is configured for a specific endpoint, it instructs the Gateway to ignore requests to the endpoint that originate from outside Tyk. | ||
|
|
||
| An internal endpoint can be targeted from another API deployed on Tyk using the `tyk://` prefix instead of `http://`. | ||
|
|
||
| For example, if `GET /status/200` is configured to be an Internal Endpoint on the listen path `http://my-tyk-install.org/my-api/` then external calls to this endpoint will be rejected with `HTTP 403 Forbidden`. Other APIs on Tyk will be able to direct traffic to this endpoint by setting their `target_url` to `tyk://my-api/status/200`. | ||
|
|
||
| #### Addressing an internal endpoint | ||
| An internal endpoint can be addressed using three different identifiers in the format `tyk://{identifier}/{endpoint}`. | ||
|
|
||
| The options for the `identifier` are: | ||
| - `self` (only if the endpoint is in the same API) | ||
| - `api_id` (the unique API Identifier assigned to the API within Tyk) | ||
| - listen path (the listen path defined for the API) | ||
|
|
||
| For example, let's say you have two APIs: | ||
|
|
||
| | api_id | listen path | Endpoint 1 | Endpoint 2 (with internal endpoint middleware) | | ||
| |--------|-------------|--------------|------------------------------------------------| | ||
| | f1c63fa5177de2719 | `/api1` | `endpoint1_ext` | `endpoint1_int` | | ||
| | 2e90b33a879945918 | `/api2` | `endpoint2_ext` | `endpoint2_int` | | ||
|
|
||
| An external request directed at `/api1/endpoint1_int` will be rejected with `HTTP 403 Forbidden`, since this is an internal endpoint. | ||
|
|
||
| This endpoint could, however, be called from within either endpoint in `/api2` as either: | ||
| - `tyk://api1/endpoint1_int` | ||
| - `tyk://f1c63fa5177de2719/endpoint1_int` | ||
|
|
||
| Or from within `/api1/endpoint1_ext` as: | ||
| - `tyk://api1/endpoint1_int` | ||
| - `tyk://f1c63fa5177de2719/endpoint1_int` | ||
| - `tyk://self/endpoint1_int` | ||
|
|
||
| <hr> | ||
|
|
||
| If you're using Tyk OAS APIs, then you can find details and examples of how to configure the Internal Endpoint middleware [here]({{< ref "product-stack/tyk-gateway/middleware/internal-endpoint-tyk-oas" >}}). | ||
|
|
||
| If you're using Tyk Classic APIs, then you can find details and examples of how to configure the Internal Endpoint middleware [here]({{< ref "product-stack/tyk-gateway/middleware/internal-endpoint-tyk-classic" >}}). | ||
|
|
||
| <!-- proposed "summary box" to be shown graphically on each middleware page | ||
| ## Internal Endpoint middleware summary | ||
| - The Internal Endpoint middleware is an optional stage in Tyk's API Request processing chain, sitting between the [TBC]() and [TBC]() middleware. | ||
| - The Internal Endpoint middleware can be configured at the per-endpoint level within the API Definition and is supported by the API Designer within the Tyk Dashboard. | ||
| --> | ||
|
|
49 changes: 49 additions & 0 deletions
49
...s/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-classic.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: Using the Internal Endpoint middleware with Tyk Classic APIs | ||
| date: 2024-01-26 | ||
| description: "Using the Internal Endpoint middleware with Tyk Classic APIs" | ||
| tags: ["internal endpoint", "internal", "middleware", "per-endpoint", "Tyk Classic"] | ||
| --- | ||
|
|
||
| The [Internal Endpoint]({{< ref "product-stack/tyk-gateway/middleware/internal-endpoint-middleware" >}}) middleware instructs Tyk Gateway not to process external requests to the endpoint (which is a combination of HTTP method and path). Internal requests from other APIs will be processed. | ||
|
|
||
| When working with Tyk Classic APIs, the middleware is configured in the Tyk Classic API Definition. You can do this via the Tyk Dashboard API or in the API Designer. | ||
|
|
||
| If you're using the newer Tyk OAS APIs, then check out the [Tyk OAS]({{< ref "product-stack/tyk-gateway/middleware/internal-endpoint-tyk-oas" >}}) page. | ||
|
|
||
| ## Configuring the middleware in the Tyk Classic API Definition | ||
|
|
||
| To enable the middleware you must add a new `internal` object to the `extended_paths` section of your API definition. | ||
|
|
||
| The `internal` object has the following configuration: | ||
| - `path`: the path to match on | ||
| - `method`: this method to match on | ||
|
|
||
| For example: | ||
| ```.json {linenos=true, linenostart=1} | ||
| { | ||
| "extended_paths": { | ||
| "internal": [ | ||
| { | ||
| "disabled": false, | ||
| "path": "/status/200", | ||
| "method": "GET" | ||
| } | ||
| ] | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| In this example the internal endpoint middleware has been configured for HTTP `GET` requests to the `/status/200` endpoint. Any requests made to this endpoint that originate externally to Tyk will be rejected with `HTTP 403 Forbidden`. Conversely, the endpoint can be reached internally by another API at `tyk://<listen_path>/status/200`. | ||
|
|
||
| ## Configuring the middleware in the API Designer | ||
|
|
||
| You can use the API Designer in the Tyk Dashboard to configure the internal endpoint middleware for your Tyk Classic API by following these steps. | ||
|
|
||
| #### Step 1: Add an endpoint for the path and select the plugin | ||
| From the **Endpoint Designer** add an endpoint that matches the path for which you want to allow access. Select the **Internal** plugin. | ||
|
|
||
| {{< img src="/img/dashboard/endpoint-designer/internal-endpoint.png" alt="Adding the internal endpoint middleware to a Tyk Classic API endpoint" >}} | ||
|
|
||
| #### Step 2: Save the API | ||
| Use the *save* or *create* buttons to save the changes and activate the middleware. |
119 changes: 119 additions & 0 deletions
119
tyk-docs/content/product-stack/tyk-gateway/middleware/internal-endpoint-tyk-oas.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,119 @@ | ||
| --- | ||
| title: Using the Internal Endpoint middleware with Tyk OAS APIs | ||
| date: 2024-01-26 | ||
| description: "Using the Internal Endpoint middleware with Tyk OAS APIs" | ||
| tags: ["internal endpoint", "internal", "middleware", "per-endpoint", "Tyk OAS"] | ||
| --- | ||
|
|
||
| The [Internal Endpoint]({{< ref "product-stack/tyk-gateway/middleware/internal-endpoint-middleware" >}}) middleware instructs Tyk Gateway not to process external requests to the endpoint (which is a combination of HTTP method and path). Internal requests from other APIs will be processed. | ||
|
|
||
| When working with Tyk OAS APIs, the middleware is configured in the [Tyk OAS API Definition]({{< ref "tyk-apis/tyk-gateway-api/oas/x-tyk-oas-doc#operation" >}}). You can do this via the Tyk Dashboard API or in the API Designer. | ||
|
|
||
| If you're using the legacy Tyk Classic APIs, then check out the [Tyk Classic]({{< ref "product-stack/tyk-gateway/middleware/internal-endpoint-tyk-classic" >}}) page. | ||
|
|
||
| ## Configuring the middleware in the Tyk OAS API Definition | ||
|
|
||
| The design of the Tyk OAS API Definition takes advantage of the `operationID` defined in the OpenAPI Document that declares both the path and method for which the middleware should be added. | ||
|
|
||
| The internal endpoint middleware (`internal`) can be added to the `operations` section of the Tyk OAS Extension (`x-tyk-api-gateway`) in your Tyk OAS API Definition for the appropriate `operationId` (as configured in the `paths` section of your OpenAPI Document). | ||
|
|
||
| The `internal` object has the following configuration: | ||
| - `enabled`: enable the middleware for the endpoint | ||
|
|
||
| For example: | ||
| ```.json {hl_lines=["49-50"],linenos=true, linenostart=1} | ||
| { | ||
| "components": {}, | ||
| "info": { | ||
| "title": "example-internal-endpoint", | ||
| "version": "1.0.0" | ||
| }, | ||
| "openapi": "3.0.3", | ||
| "paths": { | ||
| "/anything": { | ||
| "get": { | ||
| "operationId": "anythingget", | ||
| "responses": { | ||
| "200": { | ||
| "description": "" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "/redirect": { | ||
| "get": { | ||
| "operationId": "redirectget", | ||
| "responses": { | ||
| "200": { | ||
| "description": "" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "x-tyk-api-gateway": { | ||
| "info": { | ||
| "name": "example-internal-endpoint", | ||
| "state": { | ||
| "active": true | ||
| } | ||
| }, | ||
| "upstream": { | ||
| "url": "http://httpbin.org/" | ||
| }, | ||
| "server": { | ||
| "listenPath": { | ||
| "value": "/example-internal-endpoint/", | ||
| "strip": true | ||
| } | ||
| }, | ||
| "middleware": { | ||
| "operations": { | ||
| "anythingget": { | ||
| "internal": { | ||
| "enabled": true | ||
| } | ||
| }, | ||
| "redirectget": { | ||
| "urlRewrite": { | ||
| "enabled": true, | ||
| "pattern": ".*", | ||
| "rewriteTo": "tyk://self/anything" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| In this example, two endpoints have been defined: | ||
| - the internal endpoint middleware has been configured for requests to the `GET /anything` endpoint | ||
| - the [URL rewrite]({{< ref "transform-traffic/url-rewriting" >}}) middleware has been configured for requests to the `GET /redirect` endpoint | ||
|
|
||
| Any calls made directly to `GET /example-internal-endpoint/anything` will be rejected, with Tyk returning `HTTP 403 Forbidden`, since the `/anything` endpoint is internal. | ||
|
|
||
| Any calls made to `GET /example-internal-endpoint/redirect` will be redirected to `GET /example-internal-endpoint/anything`. These will be proxied to the upstream because they originate from within Tyk Gateway (i.e. they are internal requests) - so the response from `GET http://httpbin.org/anything` will be returned. | ||
|
|
||
| The configuration above is a complete and valid Tyk OAS API Definition that you can import into Tyk to try out the internal endpoint middleware. | ||
|
|
||
| ## Configuring the middleware in the API Designer | ||
|
|
||
| Adding the Internal Endpoint middleware to your API endpoints is easy when using the API Designer in the Tyk Dashboard, simply follow the following steps: | ||
|
|
||
| #### Step 1: Add an endpoint for the path | ||
| From the **API Designer** add an endpoint that matches the path you want to rewrite. | ||
|
|
||
| {{< img src="/img/dashboard/api-designer/tyk-oas-no-endpoints.png" alt="Tyk OAS API Designer showing no endpoints created" >}} | ||
|
|
||
| {{< img src="/img/dashboard/api-designer/tyk-oas-add-endpoint.png" alt="Adding an endpoint to an API using the Tyk OAS API Designer" >}} | ||
|
|
||
| {{< img src="/img/dashboard/api-designer/tyk-oas-no-middleware.png" alt="Tyk OAS API Designer showing no middleware enabled on endpoint" >}} | ||
|
|
||
| #### Step 2: Select the Internal Endpoint middleware | ||
| Select **ADD MIDDLEWARE** and choose the **Internal** middleware from the *Add Middleware* screen. | ||
|
|
||
| {{< img src="/img/dashboard/api-designer/tyk-oas-internal.png" alt="Adding the Internal Endpoint middleware" >}} | ||
|
|
||
| #### Step 3: Save the API | ||
| Select **SAVE API** to apply the changes to your API. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters