Skip to content

Commit af94762

Browse files
committed
Merge branch 'master' of https://github.com/TykTechnologies/tyk-docs into contribution-guide
2 parents 75e74d6 + 52a97ed commit af94762

File tree

18 files changed

+368
-284
lines changed

18 files changed

+368
-284
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ We have created a few guidelines to help with creating PR. To make sure these re
5555
2. Check the `PR Agent` bot for any important suggestions, spelling mistakes or typos
5656
3. The `PR Agent` bot creates a description for you. If needed, please add more info to it. Link to a GitHub issue if it exists.
5757

58-
### Pull Request Review Schedule
58+
#### Pull Request Review Schedule
5959

6060
PRs will be reviewed weekly, every Tuesday and Thursday. New reviews will be
6161
reviewed on Tuesdays and review responses will be done on Thursdays.

tyk-docs/content/api-management/gateway-config-managing-oas.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -673,7 +673,7 @@ To update just the OpenAPI description of your API in Tyk, you simply send the O
673673
| Body | OpenAPI document |
674674
| Parameters | Path: `{API-ID}` |
675675

676-
You need to specify which API to update - and so so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition stored in your main storage.
676+
You need to specify which API to update - and do so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition stored in your main storage.
677677

678678
**Applying an Updated Tyk OAS API Definition**
679679

@@ -687,7 +687,7 @@ To update the whole API in Tyk, you simply send the Tyk OAS API definition in th
687687
| Body | Tyk OAS API Definition |
688688
| Parameters | Path: `{API-ID}` |
689689

690-
You need to specify which API to update - and so so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition stored in your main storage.
690+
You need to specify which API to update - and do so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition stored in your main storage.
691691

692692
**Check request response**
693693

@@ -724,7 +724,7 @@ To update just the OpenAPI description of your API in Tyk, you simply send the O
724724
| Body | OpenAPI document |
725725
| Parameters | Path: `{API-ID}` Query: `templateId` |
726726

727-
You need to specify which API to update - and so so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition that Tyk has stored in the `/apps` folder of your Tyk Gateway installation.
727+
You need to specify which API to update - and do so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition that Tyk has stored in the `/apps` folder of your Tyk Gateway installation.
728728

729729

730730
**Applying an Updated Tyk OAS API Definition**
@@ -739,7 +739,7 @@ To update the whole API in Tyk, you simply send the Tyk OAS API definition in th
739739
| Body | Tyk OAS API Definition |
740740
| Parameters | Path: `{API-ID}` |
741741

742-
You need to specify which API to update - and so so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition that Tyk has stored in the `/apps` folder of your Tyk Gateway installation.
742+
You need to specify which API to update - and do so using the `API-ID` value from the response you received from Tyk when creating the API. You can find this in the `x-tyk-api-gateway.info.id` field of the Tyk OAS API Definition that Tyk has stored in the `/apps` folder of your Tyk Gateway installation.
743743

744744

745745
**Check request response**

tyk-docs/content/api-management/graphql.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ In order to complete the next steps, you need to have the [Tyk OSS]({{< ref "tyk
284284
285285
#### Creation Methods
286286
287-
With Tyk OSS, it is possible to create GQL APIs using Tyk's Gateway API or to generate a file with the same object and store it in the `/apps` folder of the Tyk Gateway installation folder. This is demonstrated [here]({{< ref "api-management/manage-apis/deploy-apis/deploy-apis-overview#file-based-configurations" >}}).
287+
With Tyk OSS, it is possible to create GQL APIs using Tyk's Gateway API or to generate a file with the same object and store it in the `/apps` folder of the Tyk Gateway installation folder. This is demonstrated [in the file-based configuration section]({{< ref "api-management/manage-apis/deploy-apis/deploy-apis-overview#file-based-configuration" >}}).
288288

289289

290290
#### Steps for Configuration
Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,55 @@
11
---
2-
title: API Deployment Methods
2+
title: API Creation Methods
33
date: 2023-09-04
4-
description: "Explains deployment methods for Tyk APIs"
5-
tags: [ "API Deployment", "API", "Deployment", "Deployment Methods", "Deploy APIs", "Tyk Sync", "Tyk Operator" ]
4+
description: "Different ways to create and manage APIs in Tyk"
5+
tags: [ "API Management", "API Configuration", "Dashboard", "Tyk Sync", "Tyk Operator" ]
66
---
77

8-
At Tyk, we provide various deployment methods to suit different stages of your API development lifecycle. Each option offers unique features and capabilities tailored to your specific needs.
8+
This page explains the different methods available for creating and managing APIs in Tyk, each suited to different use cases and workflow requirements.
99

10-
## File-based Configurations
10+
## File-based configuration {#file-based-configuration}
1111

12-
For Open Source users, the File-based Configurations option offers a quick way to test your gateway and API configurations using a JSON API specification. Simply load the configuration to the `/apps` folder, making it easy to experiment with different setups.
12+
Load API configurations directly to the `/apps` folder using JSON API specifications. This method is available for open source users and is ideal for testing gateway and API configurations.
1313

14-
Usage: Recommended for testing gateway and API configurations in an Open Source environment.
14+
**Use case:** Testing and experimentation in development environments.
1515

16-
Learn more:
17-
* [Tutorial: Create an API in File-based Mode]({{< ref "api-management/gateway-config-managing-classic#create-an-api-in-file-based-mode" >}})
16+
**Learn more:**
17+
* [Create an API in file-based mode]({{< ref "api-management/gateway-config-managing-classic#create-an-api-in-file-based-mode" >}})
1818

1919
## Dashboard UI
2020

21-
The Dashboard UI is ideal for Trial / POC users and anyone looking to experiment with Tyk features. It offers a user-friendly web GUI that allows you to import, create, and configure APIs easily. Changes made through the Dashboard UI take effect instantly, making it suitable for learning, testing, and Proof of Concept (PoC) purposes.
21+
Create and configure APIs through the web-based Dashboard interface. Changes take effect immediately, making this method suitable for learning, testing, and proof-of-concept work.
2222

23-
Usage: Recommended for PoC, learning, or manual testing; not intended for automation.
23+
**Use case:** Manual API management, learning, and proof-of-concept projects.
2424

25-
Learn more:
26-
* [Tutorial: Create an API with the Dashboard]({{< ref "api-management/gateway-config-managing-classic#create-an-api-with-the-dashboard" >}})
25+
**Learn more:**
26+
* [Create an API with the Dashboard]({{< ref "api-management/gateway-config-managing-classic#create-an-api-with-the-dashboard" >}})
2727

28-
## Dashboard or Gateway API
28+
## Dashboard and Gateway API
2929

30-
For programmatic control, both Tyk Pro users and Open Source users can leverage either the Dashboard API or the Gateway API. These APIs enable the creation and management of APIs, Policies, Keys, Developer Portals, and more. They provide the flexibility to automate some API operations, but it involves an imperative approach and may not be as straightforward for repetitive tasks across different environments.
30+
Programmatically create and manage APIs, policies, keys, and developer portals using REST APIs. This method provides flexibility for automation but requires imperative scripting.
3131

32-
Usage: Suitable for those who require programmatic control over API management, APIs, Policies, and other aspects of Tyk.
32+
**Use case:** Programmatic API management and basic automation needs.
3333

34-
Learn more:
34+
**Learn more:**
3535
- [Dashboard API]({{< ref "api-management/dashboard-configuration#exploring-the-dashboard-api" >}})
3636
- [Gateway API]({{< ref "tyk-gateway-api" >}})
3737

3838
## Tyk Sync
3939

40-
Tyk Sync enables declarative API management and GitOps. With Tyk Sync, you can manage API configurations in a transportable format, which can be version controlled using Git. This approach allows you to achieve automation in the API deployment process and maintain a source of truth for API configurations. By setting up a CI/CD pipeline, changes made in Git trigger the reload of configurations in Tyk Dashboard.
40+
Manage API configurations declaratively using version-controlled files. Tyk Sync enables GitOps workflows by maintaining API configurations as code that can be versioned and deployed through CI/CD pipelines.
4141

42-
Usage: Recommended for organizations looking to implement GitOps in API management and have portable API and Policy configurations.
42+
**Use case:** GitOps workflows and teams requiring version-controlled API configurations.
4343

44-
Learn more:
44+
**Learn more:**
4545
- [Tyk Sync]({{< ref "api-management/automations/sync" >}})
4646

4747
## Tyk Operator
4848

49-
Building on the capabilities of Tyk Sync and GitOps, Tyk Operator provides a powerful solution for declarative API management and constant reconciliation in dynamic environments. Leveraging Kubernetes features, Tyk Operator treats APIs and Policies as Custom Resources, allowing drift detection and automatic reconciliation. It ensures that the desired state stored in Git matches the actual state in the Tyk instance, enabling seamless management of Tyk APIs and Policies alongside other Kubernetes resources.
49+
Kubernetes-native API management using Custom Resource Definitions (CRDs). Tyk Operator provides declarative configuration with automatic drift detection and reconciliation in Kubernetes environments.
5050

51-
Usage: Recommended for organizations already running Kubernetes and seeking a Kubernetes-native, automated approach to API deployment and management.
51+
**Use case:** Kubernetes-native environments requiring automated API lifecycle management.
5252

53-
Learn more:
53+
**Learn more:**
5454
- [Tyk Operator]({{< ref "api-management/automations/operator#what-is-tyk-operator" >}})
55-
- [Using Tyk Operator to enable GitOps with Tyk]({{< ref "api-management/automations" >}})
56-
57-
With these flexible deployment options, you can easily design, develop, and deploy APIs in Tyk according to your specific requirements and workflow. Choose the option that best aligns with your needs and integrates smoothly into your API development lifecycle.
55+
- [Using Tyk Operator to enable GitOps]({{< ref "api-management/automations" >}})

tyk-docs/content/api-management/migrate-from-tyk-classic.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Migrating from Tyk Classic"
2+
title: "Migrating from Tyk Classic APIs"
33
date: 2025-02-10
44
tags: ["Tyk OAS API", "Tyk Classic API", "Migrate", "Convert", "Migration", "Tyk Classic", "Tyk OAS", "API definition"]
55
keywords: ["Tyk OAS API", "Tyk Classic API", "Migrate", "Convert", "Migration", "Tyk Classic", "Tyk OAS", "API definition"]

tyk-docs/content/api-management/plugins/rich-plugins.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1232,7 +1232,7 @@ Your *Dispatch* RPC should handle the request made by Tyk Gateway, implementing
12321232

12331233
Consult the [Tyk protocol buffers](https://github.com/TykTechnologies/tyk/tree/master/coprocess/proto) for the definition of the service and data structures that enable integration of Tyk gateway with your gRPC server. Tyk provides pre-generated [bindings](https://github.com/TykTechnologies/tyk/tree/master/coprocess/bindings) for C++, Java, Python and Ruby.
12341234

1235-
Example tutorials are available that explain how to generate the protobuf bindings and implement a server for [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-authentication-plugin-with-net" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-authentication-plugin-with-net" >}}).
1235+
Example tutorials are available that explain how to generate the protobuf bindings and implement a server for [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}).
12361236

12371237
Tyk Github repositories are also available with examples for [Ruby](https://github.com/TykTechnologies/tyk-plugin-demo-ruby) and [C#/.NET](https://github.com/TykTechnologies/tyk-plugin-demo-dotnet)
12381238

@@ -1482,7 +1482,7 @@ This guide has explained the key concepts and processes for writing gRPC plugins
14821482
#### What's Next?
14831483

14841484
- Consult the [Protocol Buffer messages]({{< ref "api-management/plugins/rich-plugins#rich-plugins-data-structures" >}}) that Tyk Gateway uses when making a request to a gRPC server.
1485-
- Visit tutorial guides that explain how to implement a [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-authentication-plugin-with-net" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-authentication-plugin-with-net" >}}) gRPC server.
1485+
- Visit tutorial guides that explain how to implement a [Java]({{< ref "api-management/plugins/rich-plugins#create-a-request-transformation-plugin-with-java" >}}), [.NET]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) and [NodeJS]({{< ref "api-management/plugins/rich-plugins#create-custom-auth-plugin-with-dotnet" >}}) gRPC server.
14861486
- Visit our [plugins hub]({{< ref "api-management/plugins/overview#plugins-hub" >}}) to explore further gRPC development examples and resources.
14871487

14881488
---
@@ -2297,7 +2297,7 @@ To publish the plugin, copy or upload `bundle.zip` to a local web server like Ng
22972297

22982298
{{< include "grpc-include" >}}
22992299

2300-
#### <a name="next"></a>What's Next?
2300+
#### What's Next? {what-is-next}
23012301

23022302
In this tutorial we learned how Tyk gRPC plugins work. For a production-level setup we suggest the following:
23032303

@@ -2308,7 +2308,7 @@ In this tutorial we learned how Tyk gRPC plugins work. For a production-level se
23082308
[3]: /img/dashboard/system-management/api_settings.png
23092309
[4]: /img/dashboard/system-management/plugin_options.png
23102310

2311-
### Create Custom Authentication Plugin with .NET
2311+
### Create Custom Authentication Plugin with .NET {#create-custom-auth-plugin-with-dotnet}
23122312

23132313
This tutorial will guide you through the creation of a custom authentication plugin for Tyk with a gRPC based plugin with .NET and C#. For additional information check the official gRPC [documentation](https://grpc.io/docs/guides/index.html).
23142314

@@ -2326,7 +2326,7 @@ The sample code that we’ll use implements a very simple authentication layer u
23262326

23272327
#### Create the Plugin
23282328

2329-
##### Create .NET Project
2329+
##### Create .NET Project {#create-dotnet-project}
23302330

23312331
We use the .NET CLI tool to generate the initial files for our project:
23322332

@@ -2349,7 +2349,7 @@ dotnet add package Google.Protobuf --version 3.4.0
23492349
- The `ThreadPool` package is used by `Grpc`.
23502350
- The `Protobuf` package will be used by our gRPC bindings.
23512351

2352-
##### Install the gRPC Tools
2352+
##### Install the gRPC Tools {#install-grpc-tools}
23532353

23542354
We need to install the gRPC tools to generate the bindings. We recommended you follow the official guide here: https://grpc.io/docs/quickstart/csharp.html#generate-grpc-code.
23552355

tyk-docs/content/apim/open-source/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ REDIS_BITNAMI_CHART_VERSION=19.0.2
142142
helm repo add tyk-helm https://helm.tyk.io/public/helm/charts/
143143
helm repo update
144144

145-
helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --install --version $REDIS_BITNAMI_CHART_VERSION
145+
helm upgrade tyk-redis oci://registry-1.docker.io/bitnamicharts/redis -n $NAMESPACE --create-namespace --install --version $REDIS_BITNAMI_CHART_VERSION
146146

147147
helm upgrade tyk-oss tyk-helm/tyk-oss -n $NAMESPACE --create-namespace \
148148
--install \

tyk-docs/content/basic-config-and-security/security/authentication-authorization/multiple-auth.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ In the following example, the OpenAPI description includes multiple security sch
7070
}
7171
```
7272

73-
Tyk will consider only the first entry in the `security` list and so will implement the `auth-A` and `auth-B` schemes.
73+
Tyk will consider only the first entry in the `security` list and so will implement the `auth-A` and `auth-C` schemes.
7474

7575
In the Tyk Vendor Extension this would result in the following configuration:
7676

0 commit comments

Comments
 (0)