You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: .github/pull_request_template.md
+1
Original file line number
Diff line number
Diff line change
@@ -25,6 +25,7 @@
25
25
<!-- Go over all the following points, and put an `x` in all the boxes that apply -->
26
26
27
27
-[ ] I have added a **preview link** to the PR description.
28
+
-[ ] I have reviewed the suggestions made by our AI (PR Agent) and updated them accordingly (spelling errors, rephrasing, etc.)
28
29
-[ ] I have [reviewed the guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING.md) for contributing to this repository.
29
30
-[ ] I have [read the technical guidelines](https://github.com/TykTechnologies/tyk-docs/blob/master/CONTRIBUTING-TECHNICAL-GUIDE.md) for contributing to this repository.
30
31
-[ ] Make sure you have started *your change* off *our latest `master`*.
description: "An overview of Tyk's customisable request and response processing chain"
4
+
description: "An overview of Tyk's customizable request and response processing chain"
5
5
aliases:
6
6
- /transform-traffic/endpoint-designer/
7
7
---
@@ -10,7 +10,7 @@ When you configure an API on Tyk, the Gateway will proxy all requests received a
10
10
11
11
Within that chain are a highly configurable set of optional middleware that can, on a per-endpint basis:
12
12
- apply processing to [API requests](#middleware-applied-to-the-api-request) before they are proxied to the upstream service
13
-
- apply customisation to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client
13
+
- apply customization to the [API response](#middleware-applied-to-the-api-response) prior to it being proxied back to the client
14
14
15
15
Tyk also supports a powerful custom plugin feature that enables you to add custom processing at different stages in the processing chains. For more details on custom plugins please see the [dedicated guide]({{< ref "plugins" >}}).
Copy file name to clipboardexpand all lines: tyk-docs/content/advanced-configuration/transform-traffic/response-headers.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ There are related [Request Header Transform]({{< ref "transform-traffic/request-
19
19
20
20
## When to use response header transformation
21
21
22
-
#### Customising responses for specific clients
22
+
#### Customizing responses for specific clients
23
23
24
24
A frequent use case for response header transformation is when a client requires specific headers for their application to function correctly. For example, a client may require a specific header to indicate the status of a request or to provide additional information about the response.
Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customise the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs.
10
+
Tyk OAS APIs have access to an increasing range of Tyk middleware that you can configure to customize the handling of API requests and responses. In this guide we will show you how to enable some of these features in your Tyk OAS APIs.
Copy file name to clipboardexpand all lines: tyk-docs/content/basic-config-and-security/report-monitor-trigger-events/webhooks.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,7 @@ aliases:
13
13
14
14
## Set up an Event Webhook with an API Definition
15
15
16
-
In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customised) to be delivered to any open endpoint.
16
+
In order to add extensibility and interoperability to Tyk, a new webhook event handler has been added. This allows a fixed payload (which can be customized) to be delivered to any open endpoint.
17
17
18
18
The webhook handler allows the configuration of the method, body, header values, and target URL and makes use of Go templates to expose the event metadata.
Copy file name to clipboardexpand all lines: tyk-docs/content/configure/outbound-email-configuration.md
+6-6
Original file line number
Diff line number
Diff line change
@@ -101,16 +101,16 @@ If `SMTPUsername` or `SMTPPassword` is omitted, Tyk assumes that authentication
101
101
"SecretAccessKey": "KEY"
102
102
},
103
103
```
104
-
### Customise your Welcome Emails
104
+
### Customize your Welcome Emails
105
105
106
-
You can customise the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process.
106
+
You can customize the welcome email that a developer recieves when they signup to your portal. You can use images and other HTML formatted content. The following video walks you through the process.
107
107
108
108
{{< youtube XNyKRAlTDVs >}}
109
109
110
110
111
111
1. Select **Settings** from your **Dashboard** > **Portal Management**
112
112
2. You can change the from email address and the from email name for your welcome emails.
113
-
3. To use customised email content, select **Enable custom welcome email**.
113
+
3. To use customized email content, select **Enable custom welcome email**.
114
114
4. You can then add the following custom content:
115
115
* Email Subject
116
116
* Email Body content
@@ -123,14 +123,14 @@ You can customise the welcome email that a developer recieves when they signup t
123
123
6. Click **Save** at the top of the Portal Settings screen.
124
124
125
125
126
-
### Customise your Key Approval Emails
126
+
### Customize your Key Approval Emails
127
127
128
128
#### Editing the Email Body
129
129
130
130
1. Select **Settings** from your **Dashboard** > **Portal Management**
131
131
2. From the "API Key approval email" section, select "Enable custom approval email", and edit the API Key email body.
Copy file name to clipboardexpand all lines: tyk-docs/content/frequently-asked-questions/custom-developer-portal-options.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,6 +9,6 @@ weight: 0
9
9
10
10
Use case: What if your developer portal is not exactly what I need?
11
11
12
-
Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customise the portal's branding per organisation?
12
+
Sometimes our Tyk Gateway won't suit your exact needs. Maybe you want to combine multiple Tyk installations under the same portal, or use your existing portal and add our functionality, or maybe customize the portal's branding per organisation?
13
13
14
14
We have the ability to configure the portal to suit your needs. For details, including a video tutorial, see [Create a Custom Developer Portal]({{< ref "tyk-developer-portal/tyk-portal-classic/customise/custom-developer-portal" >}}).
Copy file name to clipboardexpand all lines: tyk-docs/content/frequently-asked-questions/redis-persistence-using-containers.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -13,4 +13,4 @@ The Multi-Cloud Redis container is ephemeral, it isn't configured for persistenc
13
13
14
14
If using Redis with Multi-Cloud we strongly recommend using an external Redis database.
15
15
16
-
There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customise the configuration, but again, we don't recommend it.
16
+
There are no settings for Redis available via environment variable, you would need to mount a new `redis.conf` into the container to customize the configuration, but again, we don't recommend it.
The API Catalogue is part of the API Developer Portal of the Dashboard. It is the central place for you to manage which APIs your registered developers have access to.
12
+
The API Catalog is part of the API Developer Portal of the Dashboard. It is the central place for you to manage which APIs your registered developers have access to.
13
13
14
-
The API catalogue is completely separate from the regular API list section of the dashboard, as you may only wish to expose some of those APIs managed by Tyk to end users.
14
+
The API catalog is completely separate from the regular API list section of the dashboard, as you may only wish to expose some of those APIs managed by Tyk to end users.
15
15
16
-
API Catalogue entries are not actual directly tied to APIs in any way, they are connected to policies.
16
+
API Catalog entries are not actual directly tied to APIs in any way, they are connected to policies.
17
17
18
18
The reason for this is that policies can give access to a bundle of underlying APIs and therefore can represent a facade of services exposed as a single interface.
19
19
20
-
The concept of the API Catalogue is that you publish what you wish your external APIs to appear as. So, for example, if you have a widgets API that is composed of 4 microservices (i.e. `/comments`, `/pricing`, `/details`, and `/SKU`), which are managed as four separate APIs in your Dashboard, but combined under a single Security Policy (so one token can access all four APIs), then you may not wish to have your users know these are microservices, they are just endpoints in your widgets API.
20
+
The concept of the API Catalog is that you publish what you wish your external APIs to appear as. So, for example, if you have a widgets API that is composed of 4 microservices (i.e. `/comments`, `/pricing`, `/details`, and `/SKU`), which are managed as four separate APIs in your Dashboard, but combined under a single Security Policy (so one token can access all four APIs), then you may not wish to have your users know these are microservices, they are just endpoints in your widgets API.
21
21
22
22
This approach allows you to separate "management" from "consumption" using a simple CMS-based bundling approach.
Copy file name to clipboardexpand all lines: tyk-docs/content/getting-started/tutorials/publish-api.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ This is for the closed source [Tyk Developer Portal]({{< ref "tyk-developer-port
25
25
{{< tab_end >}}
26
26
{{< tab_start "Self-Managed" >}}
27
27
28
-
## Add an API and Swagger based Docs to your Portal Catalogue
28
+
## Add an API and Swagger based Docs to your Portal Catalog
29
29
30
30
Managing your portal is a key part of Tyk Dashboard, this tutorial helps you get started working with your portal and publishing your APIs to your developers.
31
31
@@ -65,15 +65,15 @@ Save the policy by clicking **Create**.
65
65
66
66
The API that you defined earlier is active and will work as you've seen in the previous tutorial, this time we want to use the Portal to generate a token for a named developer.
67
67
68
-
Not all APIs are visible to the Portal, only the ones you tell it about, so from the **Catalogue** menu, select **Add API** then:
68
+
Not all APIs are visible to the Portal, only the ones you tell it about, so from the **Catalog** menu, select **Add API** then:
69
69
70
70
1. Select your **Default** policy
71
71
2. Fill in the description fields
72
72
3. Ensure the **Enable this API** is selected
73
73
74
-
Save the API Catalogue entry by clicking **Update**.
74
+
Save the API Catalog entry by clicking **Update**.
Copy file name to clipboardexpand all lines: tyk-docs/content/planning-for-production/ensure-high-availability/enforced-timeouts.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ In any system, a task or operation takes a certain period of time to complete. W
9
9
10
10
Tyk's Enforced Timeout middleware can be used to apply a maximum time that the Gateway will wait for a response before it terminates (or times out) the request. If the timeout expires, then Tyk will notify the client with an `HTTP 504 Gateway Timeout` error.
11
11
12
-
This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customised and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality.
12
+
This feature helps to maintain system stability and prevents unresponsive or long-running tasks from affecting the overall performance of the system. The enforced timeout can be customized and configured to suit specific requirements, providing control over resource allocation and ensuring optimal system functionality.
Copy file name to clipboardexpand all lines: tyk-docs/content/plugins/supported-languages.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ The JavaScript Virtual Machine provides pluggable middleware that can modify a r
78
78
***TCP Access**: The JSVM has no socket access so working with DB drivers and directly with Redis is not possible.
79
79
80
80
### Rich Plugins
81
-
Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customised architecture to be built that integrates with a user's infrastructure.
81
+
Rich Plugins can provide replacements for existing middleware functions (as opposed to augmentation) and are designed to be full-blown, optimized, highly capable services. They enable a full customized architecture to be built that integrates with a user's infrastructure.
82
82
83
83
Rich Plugins bring about the following improvements:
Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customisation and optimization of your request handling.
18
+
Tyk's JavaScript Virtual Machine (JSVM) provides a serverless compute function that allows for the execution of custom logic directly within the gateway itself. This can be accessed from [multiple locations]({{< ref "plugins/supported-languages/javascript-middleware" >}}) in the API processing chain and allows significant customization and optimization of your request handling.
19
19
20
20
In this guide we will cover the features and resources available to you when creating custom functions, highlighting where there are limitations for the different middleware stages.
In the realm of API security, HMAC-signed authentication serves as a foundational concept. In this developer-focused blog post, we'll use HMAC-signed authentication as the basis for learning how to write gRPC custom authentication plugins with Tyk Gateway. Why learn how to write Custom Authentication Plugins?
7
7
8
-
-**Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customisation capabilities.
8
+
-**Foundational knowledge**: Writing custom authentication plugins provides foundational knowledge of Tyk's extensibility and customization capabilities.
9
9
-**Practical experience**: Gain hands-on experience in implementing custom authentication logic tailored to specific use cases, starting with HMAC-signed authentication.
10
10
-**Enhanced control**: Exercise greater control over authentication flows and response handling, empowering developers to implement advanced authentication mechanisms beyond built-in features.
11
11
@@ -655,7 +655,7 @@ While Tyk Gateway already supports HMAC-signed authentication out of the box, th
655
655
656
656
It's important to note that the authentication mechanism implemented in this guide solely verifies the HMAC signature's validity and does not include access control checks against specific API resources. Developers should enhance this implementation by integrating access control logic to ensure authenticated requests have appropriate access permissions.
657
657
658
-
By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customise API authentication solutions according to their unique requirements.
658
+
By mastering the techniques outlined in this guide, developers are better equipped to address complex authentication challenges and build robust API security architectures using Tyk Gateway's extensibility features. This guide serves as a foundation for further exploration and experimentation with custom authentication plugins, empowering developers to innovate and customize API authentication solutions according to their unique requirements.
Copy file name to clipboardexpand all lines: tyk-docs/content/plugins/supported-languages/rich-plugins/grpc/write-grpc-plugin.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,11 @@ This document serves as a developer's guide for understanding the key concepts a
16
16
17
17
This comprehensive guide covers essential tasks, including:
18
18
19
-
1.**Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customisation and tailored processing at each stage of the request lifecycle.
19
+
1.**Developing a gRPC Server:** Learn how to develop a gRPC server using [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto). The gRPC server facilitates the execution of Tyk plugins, which offer custom middleware for various phases of the API request lifecycle. By integrating these plugins, developers can enable Tyk Gateway with enhanced control and flexibility in managing API requests, allowing for fine-grained customization and tailored processing at each stage of the request lifecycle.
20
20
21
21
2.**Configuring Tyk Gateway:** Set up Tyk Gateway to communicate with your gRPC Server and, optionally, an external secured web server hosting the gRPC plugin bundle for API configurations. Configure Tyk Gateway to fetch the bundle configured for an API from the web server, enabling seamless integration with gRPC plugins. Specify connection settings for streamlined integration.
22
22
23
-
3.**API Configuration:**Customise API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility.
23
+
3.**API Configuration:**Customize API settings within Tyk Gateway to configure gRPC plugin utilization. Define plugin hooks directly within the API Definition or remotely via an external web server for seamless request orchestration. Tyk plugins provide custom middleware for different phases of the API request lifecycle, enhancing control and flexibility.
24
24
25
25
4.**API Testing:** Test that Tyk Gateway integrates with your gRPC server for the plugins configured for your API.
0 commit comments