|
1 | 1 | --- |
2 | | -title: API Deployment Methods |
| 2 | +title: API Creation Methods |
3 | 3 | 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" ] |
6 | 6 | --- |
7 | 7 |
|
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. |
9 | 9 |
|
10 | | -## File-based Configurations |
| 10 | +## File-based configuration {#file-based-configuration} |
11 | 11 |
|
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. |
13 | 13 |
|
14 | | -Usage: Recommended for testing gateway and API configurations in an Open Source environment. |
| 14 | +**Use case:** Testing and experimentation in development environments. |
15 | 15 |
|
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" >}}) |
18 | 18 |
|
19 | 19 | ## Dashboard UI |
20 | 20 |
|
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. |
22 | 22 |
|
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. |
24 | 24 |
|
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" >}}) |
27 | 27 |
|
28 | | -## Dashboard or Gateway API |
| 28 | +## Dashboard and Gateway API |
29 | 29 |
|
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. |
31 | 31 |
|
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. |
33 | 33 |
|
34 | | -Learn more: |
| 34 | +**Learn more:** |
35 | 35 | - [Dashboard API]({{< ref "api-management/dashboard-configuration#exploring-the-dashboard-api" >}}) |
36 | 36 | - [Gateway API]({{< ref "tyk-gateway-api" >}}) |
37 | 37 |
|
38 | 38 | ## Tyk Sync |
39 | 39 |
|
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. |
41 | 41 |
|
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. |
43 | 43 |
|
44 | | -Learn more: |
| 44 | +**Learn more:** |
45 | 45 | - [Tyk Sync]({{< ref "api-management/automations/sync" >}}) |
46 | 46 |
|
47 | 47 | ## Tyk Operator |
48 | 48 |
|
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. |
50 | 50 |
|
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. |
52 | 52 |
|
53 | | -Learn more: |
| 53 | +**Learn more:** |
54 | 54 | - [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" >}}) |
0 commit comments