zuplo 6.67.32 → 6.68.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -0
- package/docs/_index.md +44 -0
- package/docs/ai-gateway/apps.mdx +28 -0
- package/docs/ai-gateway/custom-providers.mdx +54 -0
- package/docs/ai-gateway/getting-started.mdx +224 -0
- package/docs/ai-gateway/guardrails.mdx +65 -0
- package/docs/ai-gateway/integrations/ai-sdk.mdx +109 -0
- package/docs/ai-gateway/integrations/claude-code.mdx +49 -0
- package/docs/ai-gateway/integrations/codex.mdx +78 -0
- package/docs/ai-gateway/integrations/goose.mdx +104 -0
- package/docs/ai-gateway/integrations/langchain.mdx +66 -0
- package/docs/ai-gateway/integrations/openai.mdx +99 -0
- package/docs/ai-gateway/introduction.mdx +85 -0
- package/docs/ai-gateway/managing-apps.mdx +46 -0
- package/docs/ai-gateway/managing-providers.mdx +66 -0
- package/docs/ai-gateway/managing-teams.mdx +63 -0
- package/docs/ai-gateway/policies/akamai-ai-firewall.mdx +125 -0
- package/docs/ai-gateway/policies/comet-opik-tracing.mdx +139 -0
- package/docs/ai-gateway/policies/galileo-tracing.mdx +147 -0
- package/docs/ai-gateway/providers.mdx +32 -0
- package/docs/ai-gateway/teams.mdx +38 -0
- package/docs/ai-gateway/universal-api.mdx +43 -0
- package/docs/ai-gateway/usage-limits.mdx +89 -0
- package/docs/api-management/introduction.md +127 -0
- package/docs/articles/accounts/audit-logs.mdx +227 -0
- package/docs/articles/accounts/billing.mdx +25 -0
- package/docs/articles/accounts/default-api-key.mdx +30 -0
- package/docs/articles/accounts/delete-account.mdx +36 -0
- package/docs/articles/accounts/enterprise-sso.mdx +116 -0
- package/docs/articles/accounts/managing-account-members.mdx +45 -0
- package/docs/articles/accounts/managing-project-members.mdx +37 -0
- package/docs/articles/accounts/members-and-roles.mdx +21 -0
- package/docs/articles/accounts/roles-and-permissions.mdx +115 -0
- package/docs/articles/accounts/zuplo-api-keys.mdx +94 -0
- package/docs/articles/add-api-to-backstage.mdx +216 -0
- package/docs/articles/advanced-path-matching.mdx +139 -0
- package/docs/articles/api-key-administration.mdx +47 -0
- package/docs/articles/api-key-api.mdx +220 -0
- package/docs/articles/api-key-authentication.mdx +195 -0
- package/docs/articles/api-key-buckets.mdx +61 -0
- package/docs/articles/api-key-end-users.mdx +52 -0
- package/docs/articles/api-key-leak-detection.mdx +75 -0
- package/docs/articles/api-key-management.mdx +100 -0
- package/docs/articles/api-key-react-component.mdx +90 -0
- package/docs/articles/api-key-service-limits.mdx +14 -0
- package/docs/articles/archiving-requests-to-storage.mdx +119 -0
- package/docs/articles/branch-based-deployments.mdx +184 -0
- package/docs/articles/bypass-policy-for-testing.mdx +117 -0
- package/docs/articles/check-ip-address.mdx +17 -0
- package/docs/articles/ci-cd-azure/basic-deployment.mdx +49 -0
- package/docs/articles/ci-cd-azure/deploy-and-test.mdx +47 -0
- package/docs/articles/ci-cd-azure/local-testing.mdx +59 -0
- package/docs/articles/ci-cd-azure/multi-stage-deployment.mdx +88 -0
- package/docs/articles/ci-cd-azure/pr-preview-environments.mdx +50 -0
- package/docs/articles/ci-cd-azure/tag-based-releases.mdx +37 -0
- package/docs/articles/ci-cd-bitbucket/basic-deployment.mdx +27 -0
- package/docs/articles/ci-cd-bitbucket/deploy-and-test.mdx +41 -0
- package/docs/articles/ci-cd-bitbucket/local-testing.mdx +34 -0
- package/docs/articles/ci-cd-bitbucket/multi-stage-deployment.mdx +52 -0
- package/docs/articles/ci-cd-bitbucket/pr-preview-environments.mdx +46 -0
- package/docs/articles/ci-cd-bitbucket/tag-based-releases.mdx +27 -0
- package/docs/articles/ci-cd-circleci/basic-deployment.mdx +34 -0
- package/docs/articles/ci-cd-circleci/deploy-and-test.mdx +44 -0
- package/docs/articles/ci-cd-circleci/local-testing.mdx +50 -0
- package/docs/articles/ci-cd-circleci/multi-stage-deployment.mdx +82 -0
- package/docs/articles/ci-cd-circleci/pr-preview-environments.mdx +47 -0
- package/docs/articles/ci-cd-circleci/tag-based-releases.mdx +38 -0
- package/docs/articles/ci-cd-github/basic-deployment.mdx +48 -0
- package/docs/articles/ci-cd-github/cleanup-on-branch-delete.mdx +123 -0
- package/docs/articles/ci-cd-github/deploy-and-test.mdx +82 -0
- package/docs/articles/ci-cd-github/local-testing.mdx +102 -0
- package/docs/articles/ci-cd-github/multi-stage-deployment.mdx +136 -0
- package/docs/articles/ci-cd-github/pr-preview-environments.mdx +106 -0
- package/docs/articles/ci-cd-github/tag-based-releases.mdx +99 -0
- package/docs/articles/ci-cd-gitlab/basic-deployment.mdx +28 -0
- package/docs/articles/ci-cd-gitlab/deploy-and-test.mdx +44 -0
- package/docs/articles/ci-cd-gitlab/local-testing.mdx +39 -0
- package/docs/articles/ci-cd-gitlab/mr-preview-environments.mdx +52 -0
- package/docs/articles/ci-cd-gitlab/multi-stage-deployment.mdx +64 -0
- package/docs/articles/ci-cd-gitlab/tag-based-releases.mdx +28 -0
- package/docs/articles/composite-policy-reference.mdx +284 -0
- package/docs/articles/configuring-auth0-for-mcp-auth.mdx +186 -0
- package/docs/articles/configuring-okta-for-mcp-auth.mdx +208 -0
- package/docs/articles/convert-urls-to-openapi.mdx +62 -0
- package/docs/articles/cors.mdx +447 -0
- package/docs/articles/custom-audit-log-policy.mdx +95 -0
- package/docs/articles/custom-ci-cd-azure.mdx +81 -0
- package/docs/articles/custom-ci-cd-bitbucket.mdx +80 -0
- package/docs/articles/custom-ci-cd-circleci.mdx +78 -0
- package/docs/articles/custom-ci-cd-github.mdx +99 -0
- package/docs/articles/custom-ci-cd-gitlab.mdx +79 -0
- package/docs/articles/custom-ci-cd.mdx +82 -0
- package/docs/articles/custom-code-patterns.md +418 -0
- package/docs/articles/custom-domains.mdx +258 -0
- package/docs/articles/custom-logging-example.mdx +139 -0
- package/docs/articles/ddos-protection.mdx +138 -0
- package/docs/articles/development-options.mdx +49 -0
- package/docs/articles/environment-variables.mdx +134 -0
- package/docs/articles/environments.mdx +143 -0
- package/docs/articles/fastly-zuplo-host-setup.mdx +41 -0
- package/docs/articles/github-deployment-testing.mdx +101 -0
- package/docs/articles/gke-with-upstream-auth-policy.mdx +192 -0
- package/docs/articles/graphql-security.mdx +180 -0
- package/docs/articles/handling-form-data.mdx +61 -0
- package/docs/articles/health-checks.mdx +109 -0
- package/docs/articles/hosting-options.mdx +70 -0
- package/docs/articles/lazy-load-configuration-into-cache.mdx +92 -0
- package/docs/articles/limits.mdx +98 -0
- package/docs/articles/local-development-debugging.mdx +44 -0
- package/docs/articles/local-development-env-variables.mdx +23 -0
- package/docs/articles/local-development-installing-packages.mdx +23 -0
- package/docs/articles/local-development-routes-designer.mdx +27 -0
- package/docs/articles/local-development-services.mdx +40 -0
- package/docs/articles/local-development-troubleshooting.mdx +56 -0
- package/docs/articles/local-development.mdx +81 -0
- package/docs/articles/log-plugin-aws-cloudwatch.mdx +83 -0
- package/docs/articles/log-plugin-datadog.mdx +84 -0
- package/docs/articles/log-plugin-dynatrace.mdx +75 -0
- package/docs/articles/log-plugin-gcp.mdx +75 -0
- package/docs/articles/log-plugin-loki.mdx +136 -0
- package/docs/articles/log-plugin-new-relic.mdx +84 -0
- package/docs/articles/log-plugin-splunk.mdx +104 -0
- package/docs/articles/log-plugin-sumo.mdx +73 -0
- package/docs/articles/log-plugin-vmware-log-insight.mdx +154 -0
- package/docs/articles/log-request-response-data.mdx +398 -0
- package/docs/articles/logging.mdx +115 -0
- package/docs/articles/manual-mcp-oauth-testing.mdx +193 -0
- package/docs/articles/mcp-quickstart.mdx +135 -0
- package/docs/articles/metrics-plugins.mdx +371 -0
- package/docs/articles/migrate-from-apigee.md +408 -0
- package/docs/articles/migrate-from-aws-api-gateway.md +248 -0
- package/docs/articles/migrate-from-azure-apim.md +292 -0
- package/docs/articles/migrate-from-kong.md +300 -0
- package/docs/articles/migration-overview.md +81 -0
- package/docs/articles/monetization/api-access.mdx +69 -0
- package/docs/articles/monetization/billing-models.md +520 -0
- package/docs/articles/monetization/developer-portal.md +167 -0
- package/docs/articles/monetization/features.mdx +98 -0
- package/docs/articles/monetization/index.mdx +113 -0
- package/docs/articles/monetization/meters.mdx +135 -0
- package/docs/articles/monetization/monetization-policy.md +314 -0
- package/docs/articles/monetization/plan-examples.mdx +366 -0
- package/docs/articles/monetization/plans.mdx +266 -0
- package/docs/articles/monetization/pricing-models.mdx +225 -0
- package/docs/articles/monetization/private-plans.md +154 -0
- package/docs/articles/monetization/quickstart.md +355 -0
- package/docs/articles/monetization/rate-cards.mdx +171 -0
- package/docs/articles/monetization/stripe-integration.md +195 -0
- package/docs/articles/monetization/subscription-lifecycle.md +298 -0
- package/docs/articles/monetization/tax-collection.md +166 -0
- package/docs/articles/monetization/troubleshooting.md +272 -0
- package/docs/articles/monetization-custom.mdx +71 -0
- package/docs/articles/monetization-integrations.mdx +104 -0
- package/docs/articles/monitoring-your-gateway.mdx +53 -0
- package/docs/articles/monorepo-deployment.mdx +350 -0
- package/docs/articles/multiple-auth-policies.mdx +81 -0
- package/docs/articles/non-standard-ports.mdx +30 -0
- package/docs/articles/oauth-authentication.mdx +54 -0
- package/docs/articles/openapi-server-urls.mdx +60 -0
- package/docs/articles/openapi.mdx +130 -0
- package/docs/articles/opentelemetry.mdx +250 -0
- package/docs/articles/per-user-rate-limits-using-db.mdx +112 -0
- package/docs/articles/performance-testing.mdx +304 -0
- package/docs/articles/plugin-akamai-api-security.mdx +76 -0
- package/docs/articles/plugin-azure-blob.mdx +73 -0
- package/docs/articles/plugin-azure-event-hubs.mdx +64 -0
- package/docs/articles/plugin-hydrolix-traffic-peak.mdx +147 -0
- package/docs/articles/policies.mdx +33 -0
- package/docs/articles/rename-or-move-project.mdx +39 -0
- package/docs/articles/rick-and-morty-api-developer-portal-example.mdx +23 -0
- package/docs/articles/routing.mdx +193 -0
- package/docs/articles/s3-signed-url-uploads.mdx +521 -0
- package/docs/articles/secure-tunnel.mdx +84 -0
- package/docs/articles/securing-backend-mtls.mdx +268 -0
- package/docs/articles/securing-your-backend.mdx +148 -0
- package/docs/articles/security.mdx +105 -0
- package/docs/articles/sharing-code-across-projects.mdx +412 -0
- package/docs/articles/source-control-setup-azure.mdx +13 -0
- package/docs/articles/source-control-setup-bitbucket.mdx +43 -0
- package/docs/articles/source-control-setup-github.mdx +172 -0
- package/docs/articles/source-control-setup-gitlab.mdx +12 -0
- package/docs/articles/source-control.mdx +80 -0
- package/docs/articles/step-1-setup-basic-gateway-local.mdx +136 -0
- package/docs/articles/step-1-setup-basic-gateway.mdx +118 -0
- package/docs/articles/step-2-add-rate-limiting-local.mdx +126 -0
- package/docs/articles/step-2-add-rate-limiting.mdx +82 -0
- package/docs/articles/step-3-add-api-key-auth-local.mdx +199 -0
- package/docs/articles/step-3-add-api-key-auth.mdx +166 -0
- package/docs/articles/step-4-deploying-to-the-edge.mdx +220 -0
- package/docs/articles/step-5-dynamic-rate-limiting.mdx +167 -0
- package/docs/articles/support.mdx +144 -0
- package/docs/articles/terraform.mdx +114 -0
- package/docs/articles/testing-graphql.mdx +34 -0
- package/docs/articles/testing.mdx +522 -0
- package/docs/articles/troubleshooting-slow-responses.mdx +301 -0
- package/docs/articles/troubleshooting.md +302 -0
- package/docs/articles/tsconfig.mdx +105 -0
- package/docs/articles/tunnel-setup.mdx +195 -0
- package/docs/articles/tunnel-troubleshooting.mdx +50 -0
- package/docs/articles/update-zup-in-github-action.mdx +110 -0
- package/docs/articles/use-openapi-extension-data.mdx +79 -0
- package/docs/articles/users/multifactor-authentication.mdx +64 -0
- package/docs/articles/users/profile.mdx +13 -0
- package/docs/articles/versioning-on-zuplo.mdx +89 -0
- package/docs/articles/waf-ddos-akamai.md +133 -0
- package/docs/articles/waf-ddos-aws-waf-shield.mdx +85 -0
- package/docs/articles/waf-ddos-fastly.mdx +251 -0
- package/docs/articles/waf-ddos.mdx +140 -0
- package/docs/articles/zuplo-waf.mdx +156 -0
- package/docs/ask.mdx +3 -0
- package/docs/cli/authentication.mdx +56 -0
- package/docs/cli/connectivity.mdx +38 -0
- package/docs/cli/create-zuplo-api.mdx +80 -0
- package/docs/cli/delete.mdx +79 -0
- package/docs/cli/deploy.mdx +156 -0
- package/docs/cli/deploy.partial.mdx +46 -0
- package/docs/cli/dev.mdx +115 -0
- package/docs/cli/docs.mdx +66 -0
- package/docs/cli/editor.mdx +50 -0
- package/docs/cli/global-options.mdx +19 -0
- package/docs/cli/init.mdx +74 -0
- package/docs/cli/link.mdx +74 -0
- package/docs/cli/list.mdx +55 -0
- package/docs/cli/mtls-certificate-create.mdx +94 -0
- package/docs/cli/mtls-certificate-delete.mdx +55 -0
- package/docs/cli/mtls-certificate-describe.mdx +55 -0
- package/docs/cli/mtls-certificate-disable.mdx +55 -0
- package/docs/cli/mtls-certificate-list.mdx +47 -0
- package/docs/cli/mtls-certificate-update.mdx +72 -0
- package/docs/cli/openapi-convert.mdx +111 -0
- package/docs/cli/openapi-merge.mdx +138 -0
- package/docs/cli/openapi-merge.partial.mdx +29 -0
- package/docs/cli/openapi-overlay.mdx +123 -0
- package/docs/cli/overview.mdx +78 -0
- package/docs/cli/project-create.mdx +43 -0
- package/docs/cli/source-migrate.mdx +18 -0
- package/docs/cli/source-upgrade.mdx +41 -0
- package/docs/cli/test.mdx +70 -0
- package/docs/cli/test.partial.mdx +7 -0
- package/docs/cli/tunnel-create.mdx +53 -0
- package/docs/cli/tunnel-create.partial.mdx +9 -0
- package/docs/cli/tunnel-delete.mdx +35 -0
- package/docs/cli/tunnel-delete.partial.mdx +9 -0
- package/docs/cli/tunnel-describe.mdx +45 -0
- package/docs/cli/tunnel-describe.partial.mdx +5 -0
- package/docs/cli/tunnel-list.mdx +35 -0
- package/docs/cli/tunnel-list.partial.mdx +9 -0
- package/docs/cli/tunnel-rate-token.partial.mdx +9 -0
- package/docs/cli/tunnel-rotate-token.mdx +39 -0
- package/docs/cli/tunnel-services-describe.mdx +45 -0
- package/docs/cli/tunnel-services-describe.partial.mdx +9 -0
- package/docs/cli/tunnel-services-update.mdx +48 -0
- package/docs/cli/variable-create.mdx +91 -0
- package/docs/cli/variable-create.partial.mdx +5 -0
- package/docs/cli/variable-update.mdx +75 -0
- package/docs/cli/variable-update.partial.mdx +5 -0
- package/docs/concepts/api-keys.md +146 -0
- package/docs/concepts/authentication.mdx +109 -0
- package/docs/concepts/how-zuplo-works.mdx +120 -0
- package/docs/concepts/project-structure.mdx +174 -0
- package/docs/concepts/rate-limiting.md +246 -0
- package/docs/concepts/request-lifecycle.mdx +56 -0
- package/docs/concepts/source-control-and-deployment.mdx +229 -0
- package/docs/conferences/conference-prize-terms.mdx +80 -0
- package/docs/dedicated/akamai/ai-powered-applications.mdx +223 -0
- package/docs/dedicated/akamai/architecture.mdx +280 -0
- package/docs/dedicated/akamai/caching.mdx +212 -0
- package/docs/dedicated/akamai/cdn.mdx +156 -0
- package/docs/dedicated/architecture.mdx +208 -0
- package/docs/dedicated/custom-domains.mdx +31 -0
- package/docs/dedicated/federated-gateways.mdx +80 -0
- package/docs/dedicated/networking.mdx +69 -0
- package/docs/dedicated/overview.mdx +80 -0
- package/docs/dedicated/source-control.mdx +63 -0
- package/docs/dev-portal/dev-portal-create-consumer-on-auth.mdx +134 -0
- package/docs/dev-portal/introduction.mdx +65 -0
- package/docs/dev-portal/local-development.mdx +72 -0
- package/docs/dev-portal/migration.mdx +526 -0
- package/docs/dev-portal/node-modules.mdx +45 -0
- package/docs/dev-portal/updating.mdx +28 -0
- package/docs/dev-portal/zudoku/components/alert.mdx +130 -0
- package/docs/dev-portal/zudoku/components/badge.mdx +70 -0
- package/docs/dev-portal/zudoku/components/button.mdx +132 -0
- package/docs/dev-portal/zudoku/components/callout.mdx +112 -0
- package/docs/dev-portal/zudoku/components/card.mdx +104 -0
- package/docs/dev-portal/zudoku/components/checkbox.mdx +72 -0
- package/docs/dev-portal/zudoku/components/client-only.mdx +79 -0
- package/docs/dev-portal/zudoku/components/code-tabs.mdx +179 -0
- package/docs/dev-portal/zudoku/components/dialog.mdx +167 -0
- package/docs/dev-portal/zudoku/components/head.mdx +199 -0
- package/docs/dev-portal/zudoku/components/icons.mdx +27 -0
- package/docs/dev-portal/zudoku/components/input.mdx +96 -0
- package/docs/dev-portal/zudoku/components/label.mdx +86 -0
- package/docs/dev-portal/zudoku/components/link.mdx +242 -0
- package/docs/dev-portal/zudoku/components/markdown.mdx +151 -0
- package/docs/dev-portal/zudoku/components/mermaid.mdx +81 -0
- package/docs/dev-portal/zudoku/components/playground.mdx +87 -0
- package/docs/dev-portal/zudoku/components/secret.mdx +78 -0
- package/docs/dev-portal/zudoku/components/select.mdx +176 -0
- package/docs/dev-portal/zudoku/components/shadcn.mdx +73 -0
- package/docs/dev-portal/zudoku/components/slider.mdx +108 -0
- package/docs/dev-portal/zudoku/components/slot.mdx +119 -0
- package/docs/dev-portal/zudoku/components/stepper.mdx +138 -0
- package/docs/dev-portal/zudoku/components/switch.mdx +96 -0
- package/docs/dev-portal/zudoku/components/syntax-highlight.mdx +602 -0
- package/docs/dev-portal/zudoku/components/textarea.mdx +78 -0
- package/docs/dev-portal/zudoku/components/tooltip.mdx +195 -0
- package/docs/dev-portal/zudoku/components/typography.mdx +61 -0
- package/docs/dev-portal/zudoku/configuration/ai-assistants.md +64 -0
- package/docs/dev-portal/zudoku/configuration/api-catalog.md +108 -0
- package/docs/dev-portal/zudoku/configuration/api-reference.md +397 -0
- package/docs/dev-portal/zudoku/configuration/authentication-auth0.md +173 -0
- package/docs/dev-portal/zudoku/configuration/authentication-azure-ad.md +238 -0
- package/docs/dev-portal/zudoku/configuration/authentication-clerk.md +110 -0
- package/docs/dev-portal/zudoku/configuration/authentication-firebase.md +61 -0
- package/docs/dev-portal/zudoku/configuration/authentication-pingfederate.md +136 -0
- package/docs/dev-portal/zudoku/configuration/authentication-supabase.md +225 -0
- package/docs/dev-portal/zudoku/configuration/authentication.md +199 -0
- package/docs/dev-portal/zudoku/configuration/build-configuration.mdx +147 -0
- package/docs/dev-portal/zudoku/configuration/docs.md +282 -0
- package/docs/dev-portal/zudoku/configuration/footer.mdx +214 -0
- package/docs/dev-portal/zudoku/configuration/llms.md +89 -0
- package/docs/dev-portal/zudoku/configuration/navigation.mdx +408 -0
- package/docs/dev-portal/zudoku/configuration/overview.md +380 -0
- package/docs/dev-portal/zudoku/configuration/protected-routes.md +149 -0
- package/docs/dev-portal/zudoku/configuration/search.md +169 -0
- package/docs/dev-portal/zudoku/configuration/sentry.mdx +44 -0
- package/docs/dev-portal/zudoku/configuration/site.md +124 -0
- package/docs/dev-portal/zudoku/configuration/slots.mdx +124 -0
- package/docs/dev-portal/zudoku/configuration/vite-config.md +18 -0
- package/docs/dev-portal/zudoku/custom-plugins.md +287 -0
- package/docs/dev-portal/zudoku/customization/colors-theme.mdx +275 -0
- package/docs/dev-portal/zudoku/customization/fonts.md +110 -0
- package/docs/dev-portal/zudoku/extending/events.md +124 -0
- package/docs/dev-portal/zudoku/guides/custom-pages.md +106 -0
- package/docs/dev-portal/zudoku/guides/environment-variables.md +99 -0
- package/docs/dev-portal/zudoku/guides/mermaid.mdx +70 -0
- package/docs/dev-portal/zudoku/guides/navigation-migration.md +87 -0
- package/docs/dev-portal/zudoku/guides/navigation-rules.mdx +197 -0
- package/docs/dev-portal/zudoku/guides/processors.mdx +234 -0
- package/docs/dev-portal/zudoku/guides/static-files.md +55 -0
- package/docs/dev-portal/zudoku/guides/transforming-examples.md +156 -0
- package/docs/dev-portal/zudoku/guides/using-multiple-apis.md +87 -0
- package/docs/dev-portal/zudoku/markdown/admonitions.md +128 -0
- package/docs/dev-portal/zudoku/markdown/code-blocks.md +196 -0
- package/docs/dev-portal/zudoku/markdown/frontmatter.md +172 -0
- package/docs/dev-portal/zudoku/markdown/mdx.md +68 -0
- package/docs/dev-portal/zudoku/markdown/overview.md +275 -0
- package/docs/dev-portal/zudoku/plugins.md +5 -0
- package/docs/dev-portal/zudoku/writing.mdx +72 -0
- package/docs/errors/bad-request.mdx +39 -0
- package/docs/errors/build-error.mdx +45 -0
- package/docs/errors/fatal-project-error.mdx +39 -0
- package/docs/errors/gateway-timeout.mdx +33 -0
- package/docs/errors/get-head-body-error.mdx +41 -0
- package/docs/errors/main-mod-error.mdx +40 -0
- package/docs/errors/no-project-set.mdx +41 -0
- package/docs/errors/not-found.mdx +43 -0
- package/docs/errors/rate-limit-exceeded.mdx +31 -0
- package/docs/errors/schema-validation-failed.mdx +51 -0
- package/docs/errors/system-configuration-error.mdx +44 -0
- package/docs/errors/unauthorized.mdx +50 -0
- package/docs/errors/unknown-error.mdx +42 -0
- package/docs/errors.mdx +14 -0
- package/docs/guides/canary-routing-for-employees.mdx +385 -0
- package/docs/guides/geolocation-backend-routing.mdx +404 -0
- package/docs/guides/modify-openapi-paths.mdx +371 -0
- package/docs/guides/openapi-overlays.mdx +492 -0
- package/docs/guides/overview.mdx +12 -0
- package/docs/guides/user-based-backend-routing.mdx +437 -0
- package/docs/handlers/aws-lambda.mdx +201 -0
- package/docs/handlers/custom-handler.mdx +112 -0
- package/docs/handlers/legacy-dev-portal-handler.mdx +135 -0
- package/docs/handlers/mcp-server.mdx +730 -0
- package/docs/handlers/openapi.mdx +78 -0
- package/docs/handlers/redirect.mdx +115 -0
- package/docs/handlers/system-handlers.mdx +41 -0
- package/docs/handlers/url-forward.mdx +204 -0
- package/docs/handlers/url-rewrite.mdx +224 -0
- package/docs/handlers/websocket-handler.mdx +154 -0
- package/docs/home.mdx +6 -0
- package/docs/managed-edge/overview.md +78 -0
- package/docs/mcp-server/configuration-migration-guide.mdx +344 -0
- package/docs/mcp-server/custom-tools.mdx +487 -0
- package/docs/mcp-server/graphql.mdx +241 -0
- package/docs/mcp-server/introduction.mdx +122 -0
- package/docs/mcp-server/openai-apps-sdk.mdx +160 -0
- package/docs/mcp-server/prompts.mdx +283 -0
- package/docs/mcp-server/resources.mdx +288 -0
- package/docs/mcp-server/testing.mdx +53 -0
- package/docs/mcp-server/tools.mdx +306 -0
- package/docs/policies/_index.md +92 -0
- package/docs/policies/ab-test-inbound/intro.md +8 -0
- package/docs/policies/ab-test-inbound/policy.ts +14 -0
- package/docs/policies/ab-test-inbound/schema.json +27 -0
- package/docs/policies/ab-test-outbound/intro.md +8 -0
- package/docs/policies/ab-test-outbound/policy.ts +26 -0
- package/docs/policies/ab-test-outbound/schema.json +27 -0
- package/docs/policies/acl-policy-inbound/intro.md +5 -0
- package/docs/policies/acl-policy-inbound/policy.ts +32 -0
- package/docs/policies/acl-policy-inbound/schema.json +52 -0
- package/docs/policies/akamai-ai-firewall/schema.json +98 -0
- package/docs/policies/amberflo-metering-inbound/doc.md +183 -0
- package/docs/policies/amberflo-metering-inbound/intro.md +20 -0
- package/docs/policies/amberflo-metering-inbound/schema.json +108 -0
- package/docs/policies/api-key-inbound/doc.md +77 -0
- package/docs/policies/api-key-inbound/intro.md +30 -0
- package/docs/policies/api-key-inbound/schema.json +84 -0
- package/docs/policies/archive-request-aws-s3-inbound/intro.md +4 -0
- package/docs/policies/archive-request-aws-s3-inbound/policy.ts +58 -0
- package/docs/policies/archive-request-aws-s3-inbound/schema.json +68 -0
- package/docs/policies/archive-request-azure-storage-inbound/doc.md +31 -0
- package/docs/policies/archive-request-azure-storage-inbound/intro.md +4 -0
- package/docs/policies/archive-request-azure-storage-inbound/policy.ts +54 -0
- package/docs/policies/archive-request-azure-storage-inbound/schema.json +53 -0
- package/docs/policies/archive-request-gcp-storage-inbound/doc.md +63 -0
- package/docs/policies/archive-request-gcp-storage-inbound/intro.md +4 -0
- package/docs/policies/archive-request-gcp-storage-inbound/policy.ts +68 -0
- package/docs/policies/archive-request-gcp-storage-inbound/schema.json +47 -0
- package/docs/policies/archive-response-aws-s3-outbound/intro.md +2 -0
- package/docs/policies/archive-response-aws-s3-outbound/policy.ts +59 -0
- package/docs/policies/archive-response-aws-s3-outbound/schema.json +68 -0
- package/docs/policies/archive-response-azure-storage-outbound/doc.md +31 -0
- package/docs/policies/archive-response-azure-storage-outbound/intro.md +3 -0
- package/docs/policies/archive-response-azure-storage-outbound/policy.ts +54 -0
- package/docs/policies/archive-response-azure-storage-outbound/schema.json +53 -0
- package/docs/policies/audit-log-inbound/doc.md +78 -0
- package/docs/policies/audit-log-inbound/intro.md +10 -0
- package/docs/policies/audit-log-inbound/schema.json +81 -0
- package/docs/policies/auth0-jwt-auth-inbound/doc.md +125 -0
- package/docs/policies/auth0-jwt-auth-inbound/intro.md +17 -0
- package/docs/policies/auth0-jwt-auth-inbound/schema.json +74 -0
- package/docs/policies/authzen-inbound/doc.md +24 -0
- package/docs/policies/authzen-inbound/intro.md +31 -0
- package/docs/policies/authzen-inbound/schema.json +126 -0
- package/docs/policies/axiomatics-authz-inbound/doc.md +144 -0
- package/docs/policies/axiomatics-authz-inbound/intro.md +11 -0
- package/docs/policies/axiomatics-authz-inbound/schema.json +161 -0
- package/docs/policies/basic-auth-inbound/intro.md +9 -0
- package/docs/policies/basic-auth-inbound/schema.json +99 -0
- package/docs/policies/bot-detection-inbound/intro.md +4 -0
- package/docs/policies/bot-detection-inbound/schema.json +56 -0
- package/docs/policies/brownout-inbound/doc.md +55 -0
- package/docs/policies/brownout-inbound/intro.md +12 -0
- package/docs/policies/brownout-inbound/schema.json +115 -0
- package/docs/policies/caching-inbound/doc.md +209 -0
- package/docs/policies/caching-inbound/intro.md +23 -0
- package/docs/policies/caching-inbound/schema.json +98 -0
- package/docs/policies/change-method-inbound/schema.json +56 -0
- package/docs/policies/clear-headers-inbound/schema.json +59 -0
- package/docs/policies/clear-headers-outbound/schema.json +59 -0
- package/docs/policies/clerk-jwt-auth-inbound/doc.md +85 -0
- package/docs/policies/clerk-jwt-auth-inbound/intro.md +4 -0
- package/docs/policies/clerk-jwt-auth-inbound/schema.json +68 -0
- package/docs/policies/cognito-jwt-auth-inbound/intro.md +7 -0
- package/docs/policies/cognito-jwt-auth-inbound/schema.json +74 -0
- package/docs/policies/comet-opik-tracing-inbound/schema.json +65 -0
- package/docs/policies/complex-rate-limit-inbound/doc.md +20 -0
- package/docs/policies/complex-rate-limit-inbound/intro.md +23 -0
- package/docs/policies/complex-rate-limit-inbound/schema.json +142 -0
- package/docs/policies/composite-inbound/doc.md +69 -0
- package/docs/policies/composite-inbound/intro.md +15 -0
- package/docs/policies/composite-inbound/schema.json +59 -0
- package/docs/policies/composite-outbound/intro.md +6 -0
- package/docs/policies/composite-outbound/schema.json +59 -0
- package/docs/policies/curity-phantom-token-inbound/doc.md +109 -0
- package/docs/policies/curity-phantom-token-inbound/intro.md +3 -0
- package/docs/policies/curity-phantom-token-inbound/schema.json +68 -0
- package/docs/policies/custom-code-inbound/doc.md +267 -0
- package/docs/policies/custom-code-inbound/intro.md +2 -0
- package/docs/policies/custom-code-inbound/schema.json +48 -0
- package/docs/policies/custom-code-outbound/doc.md +235 -0
- package/docs/policies/custom-code-outbound/intro.md +2 -0
- package/docs/policies/custom-code-outbound/schema.json +43 -0
- package/docs/policies/firebase-jwt-inbound/intro.md +6 -0
- package/docs/policies/firebase-jwt-inbound/schema.json +68 -0
- package/docs/policies/formdata-to-json-inbound/schema.json +60 -0
- package/docs/policies/galileo-tracing-inbound/schema.json +65 -0
- package/docs/policies/geo-filter-inbound/doc.md +33 -0
- package/docs/policies/geo-filter-inbound/schema.json +108 -0
- package/docs/policies/graphql-complexity-limit-inbound/doc.md +48 -0
- package/docs/policies/graphql-complexity-limit-inbound/intro.md +2 -0
- package/docs/policies/graphql-complexity-limit-inbound/schema.json +90 -0
- package/docs/policies/graphql-disable-introspection-inbound/doc.md +66 -0
- package/docs/policies/graphql-disable-introspection-inbound/intro.md +15 -0
- package/docs/policies/graphql-disable-introspection-inbound/schema.json +48 -0
- package/docs/policies/graphql-introspection-filter-outbound/doc.md +148 -0
- package/docs/policies/graphql-introspection-filter-outbound/schema.json +79 -0
- package/docs/policies/hmac-auth-inbound/doc.md +30 -0
- package/docs/policies/hmac-auth-inbound/intro.md +10 -0
- package/docs/policies/hmac-auth-inbound/policy.ts +70 -0
- package/docs/policies/hmac-auth-inbound/schema.json +53 -0
- package/docs/policies/http-deprecation-outbound/doc.md +73 -0
- package/docs/policies/http-deprecation-outbound/schema.json +83 -0
- package/docs/policies/ip-restriction-inbound/intro.md +8 -0
- package/docs/policies/ip-restriction-inbound/policy.ts +40 -0
- package/docs/policies/ip-restriction-inbound/schema.json +58 -0
- package/docs/policies/jwt-scopes-inbound/schema.json +59 -0
- package/docs/policies/ldap-auth-inbound/schema.json +56 -0
- package/docs/policies/mock-api-inbound/schema.json +72 -0
- package/docs/policies/moesif-inbound/doc.md +44 -0
- package/docs/policies/moesif-inbound/intro.md +6 -0
- package/docs/policies/moesif-inbound/schema.json +68 -0
- package/docs/policies/monetization-inbound/doc.md +87 -0
- package/docs/policies/monetization-inbound/intro.md +6 -0
- package/docs/policies/monetization-inbound/schema.json +102 -0
- package/docs/policies/mtls-auth-inbound/intro.md +6 -0
- package/docs/policies/mtls-auth-inbound/schema.json +68 -0
- package/docs/policies/okta-fga-authz-inbound/doc.md +181 -0
- package/docs/policies/okta-fga-authz-inbound/intro.md +20 -0
- package/docs/policies/okta-fga-authz-inbound/schema.json +104 -0
- package/docs/policies/okta-jwt-auth-inbound/intro.md +7 -0
- package/docs/policies/okta-jwt-auth-inbound/schema.json +74 -0
- package/docs/policies/open-id-jwt-auth-inbound/doc.md +58 -0
- package/docs/policies/open-id-jwt-auth-inbound/intro.md +30 -0
- package/docs/policies/open-id-jwt-auth-inbound/schema.json +128 -0
- package/docs/policies/openfga-authz-inbound/doc.md +207 -0
- package/docs/policies/openfga-authz-inbound/intro.md +17 -0
- package/docs/policies/openfga-authz-inbound/schema.json +191 -0
- package/docs/policies/openmeter-inbound/doc.md +163 -0
- package/docs/policies/openmeter-inbound/intro.md +18 -0
- package/docs/policies/openmeter-inbound/schema.json +183 -0
- package/docs/policies/prompt-injection-outbound/doc.md +106 -0
- package/docs/policies/prompt-injection-outbound/intro.md +4 -0
- package/docs/policies/prompt-injection-outbound/schema.json +74 -0
- package/docs/policies/propel-auth-jwt-inbound/doc.md +88 -0
- package/docs/policies/propel-auth-jwt-inbound/intro.md +4 -0
- package/docs/policies/propel-auth-jwt-inbound/schema.json +74 -0
- package/docs/policies/query-param-to-header-inbound/doc.md +70 -0
- package/docs/policies/query-param-to-header-inbound/intro.md +5 -0
- package/docs/policies/query-param-to-header-inbound/schema.json +74 -0
- package/docs/policies/quota-inbound/doc.md +235 -0
- package/docs/policies/quota-inbound/intro.md +7 -0
- package/docs/policies/quota-inbound/schema.json +133 -0
- package/docs/policies/rate-limit-inbound/doc.md +78 -0
- package/docs/policies/rate-limit-inbound/intro.md +30 -0
- package/docs/policies/rate-limit-inbound/schema.json +134 -0
- package/docs/policies/rbac-policy-inbound/intro.md +3 -0
- package/docs/policies/rbac-policy-inbound/policy.ts +42 -0
- package/docs/policies/rbac-policy-inbound/schema.json +52 -0
- package/docs/policies/readme-metrics-inbound/doc.md +1 -0
- package/docs/policies/readme-metrics-inbound/intro.md +3 -0
- package/docs/policies/readme-metrics-inbound/schema.json +84 -0
- package/docs/policies/remove-headers-inbound/schema.json +59 -0
- package/docs/policies/remove-headers-outbound/schema.json +59 -0
- package/docs/policies/remove-query-params-inbound/schema.json +59 -0
- package/docs/policies/replace-string-outbound/schema.json +69 -0
- package/docs/policies/request-size-limit-inbound/schema.json +60 -0
- package/docs/policies/request-validation-inbound/doc.md +72 -0
- package/docs/policies/request-validation-inbound/intro.md +24 -0
- package/docs/policies/request-validation-inbound/schema.json +98 -0
- package/docs/policies/require-origin-inbound/intro.md +12 -0
- package/docs/policies/require-origin-inbound/schema.json +65 -0
- package/docs/policies/secret-masking-outbound/doc.md +41 -0
- package/docs/policies/secret-masking-outbound/intro.md +13 -0
- package/docs/policies/secret-masking-outbound/schema.json +65 -0
- package/docs/policies/semantic-cache-inbound/doc.md +63 -0
- package/docs/policies/semantic-cache-inbound/intro.md +4 -0
- package/docs/policies/semantic-cache-inbound/schema.json +179 -0
- package/docs/policies/set-body-inbound/intro.md +7 -0
- package/docs/policies/set-body-inbound/schema.json +56 -0
- package/docs/policies/set-headers-inbound/doc.md +41 -0
- package/docs/policies/set-headers-inbound/intro.md +2 -0
- package/docs/policies/set-headers-inbound/schema.json +83 -0
- package/docs/policies/set-headers-outbound/schema.json +83 -0
- package/docs/policies/set-query-params-inbound/schema.json +83 -0
- package/docs/policies/set-status-outbound/schema.json +62 -0
- package/docs/policies/sleep-inbound/schema.json +56 -0
- package/docs/policies/stripe-webhook-verification-inbound/intro.md +2 -0
- package/docs/policies/stripe-webhook-verification-inbound/schema.json +60 -0
- package/docs/policies/supabase-jwt-auth-inbound/doc.md +29 -0
- package/docs/policies/supabase-jwt-auth-inbound/intro.md +12 -0
- package/docs/policies/supabase-jwt-auth-inbound/schema.json +86 -0
- package/docs/policies/transform-body-inbound/intro.md +8 -0
- package/docs/policies/transform-body-inbound/policy.ts +16 -0
- package/docs/policies/transform-body-inbound/schema.json +27 -0
- package/docs/policies/transform-body-outbound/intro.md +8 -0
- package/docs/policies/transform-body-outbound/policy.ts +19 -0
- package/docs/policies/transform-body-outbound/schema.json +27 -0
- package/docs/policies/upstream-azure-ad-service-auth-inbound/doc.md +82 -0
- package/docs/policies/upstream-azure-ad-service-auth-inbound/intro.md +20 -0
- package/docs/policies/upstream-azure-ad-service-auth-inbound/schema.json +84 -0
- package/docs/policies/upstream-firebase-admin-auth-inbound/intro.md +10 -0
- package/docs/policies/upstream-firebase-admin-auth-inbound/schema.json +68 -0
- package/docs/policies/upstream-firebase-user-auth-inbound/intro.md +2 -0
- package/docs/policies/upstream-firebase-user-auth-inbound/schema.json +113 -0
- package/docs/policies/upstream-gcp-federated-auth-inbound/doc.md +139 -0
- package/docs/policies/upstream-gcp-federated-auth-inbound/intro.md +21 -0
- package/docs/policies/upstream-gcp-federated-auth-inbound/schema.json +96 -0
- package/docs/policies/upstream-gcp-jwt-inbound/intro.md +10 -0
- package/docs/policies/upstream-gcp-jwt-inbound/schema.json +62 -0
- package/docs/policies/upstream-gcp-service-auth-inbound/doc.md +132 -0
- package/docs/policies/upstream-gcp-service-auth-inbound/intro.md +25 -0
- package/docs/policies/upstream-gcp-service-auth-inbound/schema.json +95 -0
- package/docs/policies/upstream-zuplo-jwt-auth-inbound/doc.md +213 -0
- package/docs/policies/upstream-zuplo-jwt-auth-inbound/intro.md +16 -0
- package/docs/policies/upstream-zuplo-jwt-auth-inbound/schema.json +101 -0
- package/docs/policies/validate-json-schema-inbound/doc.md +129 -0
- package/docs/policies/validate-json-schema-inbound/intro.md +7 -0
- package/docs/policies/validate-json-schema-inbound/schema.json +56 -0
- package/docs/policies/web-bot-auth-inbound/doc.md +104 -0
- package/docs/policies/web-bot-auth-inbound/intro.md +16 -0
- package/docs/policies/web-bot-auth-inbound/schema.json +76 -0
- package/docs/policies/xml-to-json-outbound/doc.md +71 -0
- package/docs/policies/xml-to-json-outbound/intro.md +4 -0
- package/docs/policies/xml-to-json-outbound/schema.json +117 -0
- package/docs/programmable-api/audit-log.mdx +74 -0
- package/docs/programmable-api/background-dispatcher.mdx +124 -0
- package/docs/programmable-api/background-loader.mdx +104 -0
- package/docs/programmable-api/cache.mdx +186 -0
- package/docs/programmable-api/compatibility-dates.mdx +201 -0
- package/docs/programmable-api/console-logging.mdx +48 -0
- package/docs/programmable-api/context-data.mdx +127 -0
- package/docs/programmable-api/custom-cors-policy.mdx +64 -0
- package/docs/programmable-api/environment.mdx +328 -0
- package/docs/programmable-api/hooks.mdx +569 -0
- package/docs/programmable-api/http-problems.mdx +385 -0
- package/docs/programmable-api/jwt-service-plugin.mdx +420 -0
- package/docs/programmable-api/logger.mdx +223 -0
- package/docs/programmable-api/memory-zone-read-through-cache.mdx +96 -0
- package/docs/programmable-api/node-modules.mdx +67 -0
- package/docs/programmable-api/not-found-handler.mdx +47 -0
- package/docs/programmable-api/oauth-protected-resource-plugin.mdx +46 -0
- package/docs/programmable-api/overview.mdx +213 -0
- package/docs/programmable-api/problem-response-formatter.mdx +183 -0
- package/docs/programmable-api/request-user.mdx +289 -0
- package/docs/programmable-api/reusing-code.mdx +26 -0
- package/docs/programmable-api/route-raw.mdx +55 -0
- package/docs/programmable-api/runtime-behaviors.mdx +25 -0
- package/docs/programmable-api/runtime-errors.mdx +246 -0
- package/docs/programmable-api/runtime-extensions.mdx +340 -0
- package/docs/programmable-api/safely-clone-a-request-or-response.mdx +57 -0
- package/docs/programmable-api/streaming-zone-cache.mdx +155 -0
- package/docs/programmable-api/web-crypto-apis.mdx +219 -0
- package/docs/programmable-api/web-standard-apis.mdx +109 -0
- package/docs/programmable-api/zone-cache.mdx +131 -0
- package/docs/programmable-api/zp-body-removed.mdx +32 -0
- package/docs/programmable-api/zuplo-context.mdx +414 -0
- package/docs/programmable-api/zuplo-id-token.mdx +90 -0
- package/docs/programmable-api/zuplo-json.mdx +91 -0
- package/docs/programmable-api/zuplo-request.mdx +200 -0
- package/docs/sample-apis.mdx +78 -0
- package/docs/self-hosted/overview.md +60 -0
- package/package.json +6 -5
|
@@ -0,0 +1,408 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Migrate from Google Apigee to Zuplo
|
|
3
|
+
sidebar_label: Migrate from Apigee
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
This guide walks through migrating from Google Apigee (including Apigee X,
|
|
7
|
+
Apigee hybrid, and legacy Apigee Edge) to Zuplo. It covers the key differences,
|
|
8
|
+
concept mapping, policy translation, and a step-by-step migration process.
|
|
9
|
+
|
|
10
|
+
:::caution{title="Apigee Edge End of Life"}
|
|
11
|
+
|
|
12
|
+
Apigee Edge for Private Cloud v4.53 reached end of life on April 11, 2026. The
|
|
13
|
+
final version (v4.53.01) reaches end of life on **February 26, 2027**. After
|
|
14
|
+
these dates, Google provides no security patches, bug fixes, or support. If you
|
|
15
|
+
are still running Apigee Edge, now is the time to migrate.
|
|
16
|
+
|
|
17
|
+
:::
|
|
18
|
+
|
|
19
|
+
## Pre-migration checklist
|
|
20
|
+
|
|
21
|
+
Before starting your migration, gather the following from your Apigee
|
|
22
|
+
environment:
|
|
23
|
+
|
|
24
|
+
- [ ] **API proxy inventory** — List all active API proxies, their base paths,
|
|
25
|
+
and target endpoints
|
|
26
|
+
- [ ] **OpenAPI specs** — Export specs for each proxy (or document endpoints if
|
|
27
|
+
specs don't exist)
|
|
28
|
+
- [ ] **Policy audit** — List every policy attached to each proxy
|
|
29
|
+
(authentication, rate limiting, transformation, etc.)
|
|
30
|
+
- [ ] **Environment configuration** — Document KVM entries, target servers,
|
|
31
|
+
keystores, and virtual host settings
|
|
32
|
+
- [ ] **Developer portal content** — Export API documentation, custom pages, and
|
|
33
|
+
developer account data
|
|
34
|
+
- [ ] **CI/CD pipeline configuration** — Document your current deployment
|
|
35
|
+
process and any automation scripts
|
|
36
|
+
- [ ] **Traffic patterns** — Understand request volumes, peak usage times, and
|
|
37
|
+
geographic distribution of API consumers
|
|
38
|
+
- [ ] **Custom Java callouts** — Identify any Java callouts that will need
|
|
39
|
+
translation to TypeScript
|
|
40
|
+
|
|
41
|
+
## Why teams migrate from Apigee
|
|
42
|
+
|
|
43
|
+
Apigee is one of the oldest API management platforms, acquired by Google
|
|
44
|
+
in 2016. While it offers deep enterprise analytics and compliance features,
|
|
45
|
+
teams increasingly find the platform difficult to justify:
|
|
46
|
+
|
|
47
|
+
- **Apigee Edge end-of-life** — Google has been sunsetting legacy Apigee Edge
|
|
48
|
+
(on-premises and private cloud) versions, pushing customers to migrate to
|
|
49
|
+
Apigee X on Google Cloud. This forced migration is an opportunity to evaluate
|
|
50
|
+
modern alternatives.
|
|
51
|
+
- **Google Cloud lock-in** — Apigee X is tightly coupled to Google Cloud
|
|
52
|
+
Platform. While Apigee hybrid exists, it adds operational complexity. Teams
|
|
53
|
+
running multi-cloud or non-GCP backends face unnecessary friction.
|
|
54
|
+
- **High cost** — Apigee pricing starts at approximately $1,500/month for just
|
|
55
|
+
100K requests, with separate charges for environments, analytics, and
|
|
56
|
+
developer portals. Enterprise contracts often require five-figure monthly
|
|
57
|
+
commitments.
|
|
58
|
+
- **XML-based policy configuration** — Apigee policies are configured in verbose
|
|
59
|
+
XML files that are difficult to read, maintain, and version control. Custom
|
|
60
|
+
logic uses a limited JavaScript engine.
|
|
61
|
+
- **Slow deployment cycles** — Apigee deployments can take several minutes to
|
|
62
|
+
propagate, slowing down the development iteration loop.
|
|
63
|
+
- **Drupal-based developer portal** — Apigee's developer portal is built on
|
|
64
|
+
Drupal, requiring significant setup, customization, and ongoing maintenance.
|
|
65
|
+
|
|
66
|
+
:::tip
|
|
67
|
+
|
|
68
|
+
Zuplo has a video walkthrough of the Apigee to Zuplo migration process:
|
|
69
|
+
[Migrating from Apigee API Management Made Easy](https://zuplo.com/videos/migrating-from-apigee-api-management-made-easy).
|
|
70
|
+
|
|
71
|
+
:::
|
|
72
|
+
|
|
73
|
+
## Concept mapping: Apigee to Zuplo
|
|
74
|
+
|
|
75
|
+
| Apigee concept | Zuplo equivalent |
|
|
76
|
+
| ----------------------- | ---------------------------------------------------------------------- |
|
|
77
|
+
| API Proxy | Routes in your [OpenAPI spec](./openapi.md) |
|
|
78
|
+
| ProxyEndpoint | Route path + [handler](../handlers/url-forward.md) |
|
|
79
|
+
| TargetEndpoint | [URL forward handler](../handlers/url-forward.md) base URL |
|
|
80
|
+
| Policy (XML) | [Policy](./policies.md) (TypeScript) or built-in policy |
|
|
81
|
+
| PreFlow / PostFlow | Inbound / outbound [policies](./policies.md) |
|
|
82
|
+
| Conditional flow | Custom code in a [custom policy](../policies/custom-code-inbound.md) |
|
|
83
|
+
| SharedFlow | Reusable [custom code module](../programmable-api/reusing-code.md) |
|
|
84
|
+
| Environment | [Environment](./environments.md) |
|
|
85
|
+
| API Product | API key with [metadata](./api-key-management.md) |
|
|
86
|
+
| Developer App | [API key consumer](./api-key-management.md) |
|
|
87
|
+
| Apigee Developer Portal | [Zuplo Developer Portal](../dev-portal/introduction.md) |
|
|
88
|
+
| VerifyAPIKey policy | [API Key Authentication](../policies/api-key-inbound.md) |
|
|
89
|
+
| OAuthV2 policy | [JWT authentication policies](../policies/open-id-jwt-auth-inbound.md) |
|
|
90
|
+
| SpikeArrest | [Rate Limiting](../policies/rate-limit-inbound.md) |
|
|
91
|
+
| Quota | [Quota policy](../policies/quota-inbound.md) |
|
|
92
|
+
| KVM (Key Value Map) | [Environment variables](./environment-variables.md) |
|
|
93
|
+
| Management API | [Zuplo API](./accounts/zuplo-api-keys.md) |
|
|
94
|
+
|
|
95
|
+
## Step-by-step migration
|
|
96
|
+
|
|
97
|
+
### Step 1: Export your API definitions
|
|
98
|
+
|
|
99
|
+
Apigee API proxies contain OpenAPI specs or can generate them. Export your API
|
|
100
|
+
definitions:
|
|
101
|
+
|
|
102
|
+
1. In the Apigee console, navigate to your API proxy.
|
|
103
|
+
2. Download the OpenAPI spec from the **Develop** tab, or export the proxy
|
|
104
|
+
bundle as a ZIP file and extract the spec.
|
|
105
|
+
3. If no spec exists, create one from your proxy's endpoint and resource
|
|
106
|
+
definitions.
|
|
107
|
+
|
|
108
|
+
### Step 2: Map Apigee policies to Zuplo policies
|
|
109
|
+
|
|
110
|
+
The following table maps common Apigee policies to Zuplo equivalents:
|
|
111
|
+
|
|
112
|
+
| Apigee policy | Zuplo policy |
|
|
113
|
+
| ------------------------- | ------------------------------------------------------------------------------------------------ |
|
|
114
|
+
| `VerifyAPIKey` | [API Key Authentication](../policies/api-key-inbound.md) |
|
|
115
|
+
| `OAuthV2` | [Open ID JWT Authentication](../policies/open-id-jwt-auth-inbound.md) |
|
|
116
|
+
| `BasicAuthentication` | [Basic Authentication](../policies/basic-auth-inbound.md) |
|
|
117
|
+
| `SpikeArrest` | [Rate Limiting](../policies/rate-limit-inbound.md) |
|
|
118
|
+
| `Quota` | [Quota](../policies/quota-inbound.md) |
|
|
119
|
+
| `AssignMessage` | [Set Headers](../policies/set-headers-inbound.md) or [Set Body](../policies/set-body-inbound.md) |
|
|
120
|
+
| `ExtractVariables` | [Custom Code Policy](../policies/custom-code-inbound.md) |
|
|
121
|
+
| `XMLToJSON` / `JSONToXML` | [XML to JSON](../policies/xml-to-json-outbound.md) or custom code |
|
|
122
|
+
| `RaiseFault` | Custom code returning an error [Response](../programmable-api/http-problems.md) |
|
|
123
|
+
| `AccessControl` | [IP Restriction](../policies/ip-restriction-inbound.md) |
|
|
124
|
+
| `CORS` | Built-in [CORS configuration](../programmable-api/custom-cors-policy.md) |
|
|
125
|
+
| `JavaScript` callout | [Custom Code Policy](../policies/custom-code-inbound.md) (TypeScript) |
|
|
126
|
+
| `ServiceCallout` | [Custom Code Policy](../policies/custom-code-inbound.md) using `fetch()` |
|
|
127
|
+
|
|
128
|
+
### Step 3: Translate policy configuration
|
|
129
|
+
|
|
130
|
+
Here is an example of translating an Apigee SpikeArrest policy to a Zuplo rate
|
|
131
|
+
limit policy.
|
|
132
|
+
|
|
133
|
+
**Apigee XML policy:**
|
|
134
|
+
|
|
135
|
+
```xml
|
|
136
|
+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
137
|
+
<SpikeArrest name="SA-RateLimit">
|
|
138
|
+
<Rate>100pm</Rate>
|
|
139
|
+
<Identifier ref="request.header.x-api-key"/>
|
|
140
|
+
<UseEffectiveCount>true</UseEffectiveCount>
|
|
141
|
+
</SpikeArrest>
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
**Zuplo policy configuration:**
|
|
145
|
+
|
|
146
|
+
```json
|
|
147
|
+
{
|
|
148
|
+
"name": "rate-limit-inbound",
|
|
149
|
+
"policyType": "rate-limit-inbound",
|
|
150
|
+
"handler": {
|
|
151
|
+
"export": "RateLimitInboundPolicy",
|
|
152
|
+
"module": "$import(@zuplo/runtime)",
|
|
153
|
+
"options": {
|
|
154
|
+
"rateLimitBy": "user",
|
|
155
|
+
"requestsAllowed": 100,
|
|
156
|
+
"timeWindowMinutes": 1
|
|
157
|
+
}
|
|
158
|
+
}
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
:::note
|
|
163
|
+
|
|
164
|
+
Apigee's SpikeArrest uses a smoothing algorithm that spreads allowed requests
|
|
165
|
+
evenly across the time window. Zuplo's rate limiter uses a sliding window
|
|
166
|
+
algorithm and is globally distributed — limits are enforced across all 300+ edge
|
|
167
|
+
locations as a single zone, unlike Apigee which synchronizes within a region but
|
|
168
|
+
not across regions by default.
|
|
169
|
+
|
|
170
|
+
:::
|
|
171
|
+
|
|
172
|
+
Here is an example of translating an Apigee OAuthV2 verification policy to a
|
|
173
|
+
Zuplo JWT authentication policy.
|
|
174
|
+
|
|
175
|
+
**Apigee OAuthV2 policy:**
|
|
176
|
+
|
|
177
|
+
```xml
|
|
178
|
+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
179
|
+
<OAuthV2 name="VerifyAccessToken">
|
|
180
|
+
<Operation>VerifyAccessToken</Operation>
|
|
181
|
+
<ExternalAuthorization>false</ExternalAuthorization>
|
|
182
|
+
<SupportedGrantTypes>
|
|
183
|
+
<GrantType>client_credentials</GrantType>
|
|
184
|
+
</SupportedGrantTypes>
|
|
185
|
+
</OAuthV2>
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
**Zuplo JWT authentication policy configuration:**
|
|
189
|
+
|
|
190
|
+
```json
|
|
191
|
+
{
|
|
192
|
+
"name": "jwt-auth-inbound",
|
|
193
|
+
"policyType": "open-id-jwt-auth-inbound",
|
|
194
|
+
"handler": {
|
|
195
|
+
"export": "OpenIdJwtInboundPolicy",
|
|
196
|
+
"module": "$import(@zuplo/runtime)",
|
|
197
|
+
"options": {
|
|
198
|
+
"issuer": "$env(AUTH_ISSUER)",
|
|
199
|
+
"audience": "$env(AUTH_AUDIENCE)",
|
|
200
|
+
"jwkUrl": "$env(AUTH_JWK_URL)",
|
|
201
|
+
"allowUnauthenticatedRequests": false
|
|
202
|
+
}
|
|
203
|
+
}
|
|
204
|
+
}
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
:::note
|
|
208
|
+
|
|
209
|
+
Apigee can act as a full OAuth 2.0 server (issuing and managing tokens). Zuplo
|
|
210
|
+
validates tokens issued by external identity providers (Auth0, Cognito, Clerk,
|
|
211
|
+
Firebase, Supabase, or any OIDC-compliant provider). If you are using Apigee as
|
|
212
|
+
your OAuth server, you will need to move token issuance to a dedicated identity
|
|
213
|
+
provider during migration.
|
|
214
|
+
|
|
215
|
+
:::
|
|
216
|
+
|
|
217
|
+
Here is an example of translating an Apigee ResponseCache to a Zuplo caching
|
|
218
|
+
policy.
|
|
219
|
+
|
|
220
|
+
**Apigee ResponseCache policy:**
|
|
221
|
+
|
|
222
|
+
```xml
|
|
223
|
+
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
|
|
224
|
+
<ResponseCache name="Cache-Response">
|
|
225
|
+
<CacheKey>
|
|
226
|
+
<KeyFragment ref="request.uri"/>
|
|
227
|
+
</CacheKey>
|
|
228
|
+
<ExpirySettings>
|
|
229
|
+
<TimeoutInSec>300</TimeoutInSec>
|
|
230
|
+
</ExpirySettings>
|
|
231
|
+
</ResponseCache>
|
|
232
|
+
```
|
|
233
|
+
|
|
234
|
+
**Zuplo caching policy configuration:**
|
|
235
|
+
|
|
236
|
+
```json
|
|
237
|
+
{
|
|
238
|
+
"name": "caching-inbound",
|
|
239
|
+
"policyType": "caching-inbound",
|
|
240
|
+
"handler": {
|
|
241
|
+
"export": "CachingInboundPolicy",
|
|
242
|
+
"module": "$import(@zuplo/runtime)",
|
|
243
|
+
"options": {
|
|
244
|
+
"expirationSecondsTtl": 300
|
|
245
|
+
}
|
|
246
|
+
}
|
|
247
|
+
}
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Step 4: Translate JavaScript callouts to TypeScript
|
|
251
|
+
|
|
252
|
+
If you use Apigee JavaScript callouts, rewrite them as Zuplo custom code
|
|
253
|
+
policies in TypeScript.
|
|
254
|
+
|
|
255
|
+
**Apigee JavaScript callout:**
|
|
256
|
+
|
|
257
|
+
```javascript
|
|
258
|
+
var apiKey = context.getVariable("request.header.x-api-key");
|
|
259
|
+
var clientId = context.getVariable("request.header.x-client-id");
|
|
260
|
+
|
|
261
|
+
if (!apiKey || !clientId) {
|
|
262
|
+
context.setVariable("isError", true);
|
|
263
|
+
context.setVariable("errorMessage", "Missing required headers");
|
|
264
|
+
}
|
|
265
|
+
|
|
266
|
+
var payload = JSON.parse(context.getVariable("request.content"));
|
|
267
|
+
payload.enriched = true;
|
|
268
|
+
payload.timestamp = new Date().toISOString();
|
|
269
|
+
context.setVariable("request.content", JSON.stringify(payload));
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
**Equivalent Zuplo TypeScript policy:**
|
|
273
|
+
|
|
274
|
+
```typescript
|
|
275
|
+
import { ZuploContext, ZuploRequest, HttpProblems } from "@zuplo/runtime";
|
|
276
|
+
|
|
277
|
+
export default async function (
|
|
278
|
+
request: ZuploRequest,
|
|
279
|
+
context: ZuploContext,
|
|
280
|
+
options: never,
|
|
281
|
+
policyName: string,
|
|
282
|
+
) {
|
|
283
|
+
const apiKey = request.headers.get("x-api-key");
|
|
284
|
+
const clientId = request.headers.get("x-client-id");
|
|
285
|
+
|
|
286
|
+
if (!apiKey || !clientId) {
|
|
287
|
+
return HttpProblems.badRequest(request, context, {
|
|
288
|
+
detail: "Missing required headers",
|
|
289
|
+
});
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
const payload = await request.json();
|
|
293
|
+
payload.enriched = true;
|
|
294
|
+
payload.timestamp = new Date().toISOString();
|
|
295
|
+
|
|
296
|
+
return new ZuploRequest(request, {
|
|
297
|
+
body: JSON.stringify(payload),
|
|
298
|
+
headers: {
|
|
299
|
+
...Object.fromEntries(request.headers.entries()),
|
|
300
|
+
"content-type": "application/json",
|
|
301
|
+
},
|
|
302
|
+
});
|
|
303
|
+
}
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
### Step 5: Migrate your developer portal
|
|
307
|
+
|
|
308
|
+
Apigee's Drupal-based developer portal requires significant setup and
|
|
309
|
+
maintenance. Zuplo's [Developer Portal](../dev-portal/introduction.md) is
|
|
310
|
+
automatically generated from your OpenAPI spec and includes:
|
|
311
|
+
|
|
312
|
+
- Interactive API reference documentation
|
|
313
|
+
- Self-serve API key management
|
|
314
|
+
- Built-in authentication
|
|
315
|
+
- Customizable theming
|
|
316
|
+
- Zero maintenance — it updates automatically when your API changes
|
|
317
|
+
|
|
318
|
+
### Step 6: Migrate environment configuration
|
|
319
|
+
|
|
320
|
+
**Apigee KVMs to Zuplo environment variables:**
|
|
321
|
+
|
|
322
|
+
Apigee uses Key Value Maps (KVMs) for environment-specific configuration. In
|
|
323
|
+
Zuplo, use [environment variables](./environment-variables.md):
|
|
324
|
+
|
|
325
|
+
| Apigee KVM | Zuplo environment variable |
|
|
326
|
+
| ----------------------------------- | ----------------------------------- |
|
|
327
|
+
| `kvm.get("backend-url")` | `$env(BACKEND_URL)` in route config |
|
|
328
|
+
| `context.getVariable("my-kvm.key")` | `context.env.MY_KEY` in custom code |
|
|
329
|
+
| Encrypted KVM entries | Secret environment variables |
|
|
330
|
+
|
|
331
|
+
### Step 7: Deploy and migrate traffic
|
|
332
|
+
|
|
333
|
+
1. Deploy your Zuplo project by pushing to your connected Git repository.
|
|
334
|
+
2. Set up a [custom domain](./custom-domains.md) for your Zuplo gateway.
|
|
335
|
+
3. Route a subset of traffic to Zuplo using DNS-based traffic splitting.
|
|
336
|
+
4. Monitor both gateways and compare behavior.
|
|
337
|
+
5. Gradually shift all traffic to Zuplo.
|
|
338
|
+
6. Decommission your Apigee environment.
|
|
339
|
+
|
|
340
|
+
## Apigee Edge to Zuplo: a special case
|
|
341
|
+
|
|
342
|
+
If you are migrating from legacy Apigee Edge (on-premises or private cloud)
|
|
343
|
+
rather than Apigee X, the migration to Zuplo is an opportunity to modernize
|
|
344
|
+
without the complexity of moving to Apigee X:
|
|
345
|
+
|
|
346
|
+
- **Skip the Apigee X migration** — Instead of migrating from Edge to X (which
|
|
347
|
+
Google recommends but requires significant effort), migrate directly to Zuplo.
|
|
348
|
+
- **Eliminate infrastructure** — Apigee Edge requires managing on-premises
|
|
349
|
+
infrastructure (Cassandra, ZooKeeper, Qpid clusters). Zuplo is fully managed.
|
|
350
|
+
- **Reduce costs** — Apigee X pricing is often higher than Edge licensing. Zuplo
|
|
351
|
+
offers transparent, usage-based pricing starting with a free tier.
|
|
352
|
+
- **No GCP dependency** — Apigee X requires Google Cloud Platform. Apigee hybrid
|
|
353
|
+
still requires GCP for its control plane. Zuplo is cloud-agnostic and can
|
|
354
|
+
front backends on any cloud provider.
|
|
355
|
+
|
|
356
|
+
### Apigee Edge end-of-life timeline
|
|
357
|
+
|
|
358
|
+
| Version | End-of-life date | Status |
|
|
359
|
+
| ------- | --------------------- | ------------- |
|
|
360
|
+
| 4.52.00 | August 31, 2024 | EOL reached |
|
|
361
|
+
| 4.52.01 | September 30, 2025 | EOL reached |
|
|
362
|
+
| 4.52.02 | December 31, 2025 | EOL reached |
|
|
363
|
+
| 4.53.00 | April 11, 2026 | EOL reached |
|
|
364
|
+
| 4.53.01 | **February 26, 2027** | Final version |
|
|
365
|
+
|
|
366
|
+
After end of life, Google provides no security patches, bug fixes, hot fixes, or
|
|
367
|
+
technical support for that version.
|
|
368
|
+
|
|
369
|
+
## Common migration gotchas
|
|
370
|
+
|
|
371
|
+
**Encrypted KVM entries cannot be exported.** Apigee's management API does not
|
|
372
|
+
return values for encrypted Key Value Map entries. You will need to manually
|
|
373
|
+
re-enter these values as Zuplo secret environment variables.
|
|
374
|
+
|
|
375
|
+
**Apigee's OAuth server has no direct equivalent.** If you use Apigee to issue
|
|
376
|
+
and manage OAuth tokens (not just validate them), you will need to move token
|
|
377
|
+
issuance to a dedicated identity provider such as Auth0, Cognito, or Clerk.
|
|
378
|
+
Zuplo validates tokens from external providers but does not act as an OAuth
|
|
379
|
+
server.
|
|
380
|
+
|
|
381
|
+
**Shared flows become reusable modules.** Apigee shared flows that are
|
|
382
|
+
referenced across multiple proxies should be refactored into reusable TypeScript
|
|
383
|
+
modules. See [Reusing Code](../programmable-api/reusing-code.md).
|
|
384
|
+
|
|
385
|
+
**Java callouts require rewriting.** Apigee Java callouts have no direct
|
|
386
|
+
TypeScript equivalent. Evaluate each callout and rewrite the logic as a
|
|
387
|
+
[custom code policy](../policies/custom-code-inbound.md). In most cases, the
|
|
388
|
+
TypeScript version will be simpler because you have access to the full npm
|
|
389
|
+
ecosystem and standard web APIs.
|
|
390
|
+
|
|
391
|
+
**Apigee analytics must be replaced.** Apigee's built-in analytics dashboards
|
|
392
|
+
and custom reports do not migrate. Zuplo provides built-in analytics and
|
|
393
|
+
integrates with observability platforms like [Datadog](./log-plugin-datadog.mdx)
|
|
394
|
+
and [Google Cloud Logging](./log-plugin-gcp.mdx) for advanced reporting.
|
|
395
|
+
|
|
396
|
+
**Test with representative traffic before cutover.** Use Zuplo's
|
|
397
|
+
[branch-based deployments](./branch-based-deployments.md) to create a preview
|
|
398
|
+
environment and route a subset of traffic through Zuplo before migrating
|
|
399
|
+
production traffic. Compare response codes, latencies, and payload correctness
|
|
400
|
+
between both gateways.
|
|
401
|
+
|
|
402
|
+
## Next steps
|
|
403
|
+
|
|
404
|
+
- [Set up your first Zuplo gateway](./step-1-setup-basic-gateway.md)
|
|
405
|
+
- [Add rate limiting](./step-2-add-rate-limiting.md)
|
|
406
|
+
- [Add API key authentication](./step-3-add-api-key-auth.md)
|
|
407
|
+
- [Configure your developer portal](../dev-portal/introduction.md)
|
|
408
|
+
- [Set up source control](./source-control.md)
|
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Migrate from AWS API Gateway to Zuplo
|
|
3
|
+
sidebar_label: Migrate from AWS API Gateway
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
This guide walks through migrating from AWS API Gateway (REST API, HTTP API, or
|
|
7
|
+
WebSocket API) to Zuplo. It covers the key differences, concept mapping, and a
|
|
8
|
+
step-by-step migration process.
|
|
9
|
+
|
|
10
|
+
## Why teams migrate from AWS API Gateway
|
|
11
|
+
|
|
12
|
+
AWS API Gateway is a natural choice for teams already building on AWS. However,
|
|
13
|
+
as API programs grow, teams encounter several limitations:
|
|
14
|
+
|
|
15
|
+
- **AWS lock-in** — AWS API Gateway only works within the AWS ecosystem. If your
|
|
16
|
+
backends span multiple cloud providers or you want to avoid single-vendor
|
|
17
|
+
dependency, you need a multi-cloud solution.
|
|
18
|
+
- **No built-in developer portal** — AWS API Gateway does not include a
|
|
19
|
+
developer-facing portal. The "Serverless Developer Portal" is a reference
|
|
20
|
+
implementation that requires self-hosting and maintenance.
|
|
21
|
+
- **Complex customization** — Custom request/response transformations use
|
|
22
|
+
Velocity Template Language (VTL) for REST APIs, a templating language that is
|
|
23
|
+
difficult to write, debug, and maintain. More complex logic requires separate
|
|
24
|
+
Lambda functions.
|
|
25
|
+
- **Region-bound traffic** — AWS API Gateway routes traffic through specific AWS
|
|
26
|
+
regions, not a global edge network. Users far from your selected region
|
|
27
|
+
experience higher latency.
|
|
28
|
+
- **CloudFormation complexity** — Managing API Gateway configuration through
|
|
29
|
+
CloudFormation, SAM, or CDK templates adds significant complexity and slow
|
|
30
|
+
deployment cycles.
|
|
31
|
+
- **Limited rate limiting** — Throttling is global or stage-based with limited
|
|
32
|
+
per-user or per-key customization. There is no built-in sliding window rate
|
|
33
|
+
limiter.
|
|
34
|
+
|
|
35
|
+
## Concept mapping: AWS API Gateway to Zuplo
|
|
36
|
+
|
|
37
|
+
| AWS API Gateway concept | Zuplo equivalent |
|
|
38
|
+
| ------------------------------ | ------------------------------------------------------------------------------------------------------------- |
|
|
39
|
+
| REST API / HTTP API | [OpenAPI route configuration](./openapi.md) |
|
|
40
|
+
| Resource | Route path in OpenAPI spec |
|
|
41
|
+
| Method | HTTP method on a route |
|
|
42
|
+
| Integration (Lambda, HTTP) | [Handler](../handlers/url-forward.md) (URL Forward, URL Rewrite, Custom) |
|
|
43
|
+
| Lambda Authorizer | [Authentication policy](../policies/api-key-inbound.md) or [custom code](../policies/custom-code-inbound.md) |
|
|
44
|
+
| API Key + Usage Plan | [API Key Authentication](../policies/api-key-inbound.md) + [Rate Limiting](../policies/rate-limit-inbound.md) |
|
|
45
|
+
| Stage | [Environment](./environments.md) |
|
|
46
|
+
| Stage variables | [Environment variables](./environment-variables.md) |
|
|
47
|
+
| Request/Response mapping (VTL) | [Custom code policy](../policies/custom-code-inbound.md) (TypeScript) |
|
|
48
|
+
| CloudFormation / SAM / CDK | [GitOps deployment](./source-control.md) via `git push` |
|
|
49
|
+
| CloudWatch Logs | [Logging integrations](./logging.md) (Datadog, Splunk, etc.) |
|
|
50
|
+
| WAF integration | [WAF & DDoS protection](./waf-ddos.md) |
|
|
51
|
+
| Custom domain | [Custom domains](./custom-domains.md) |
|
|
52
|
+
|
|
53
|
+
## Step-by-step migration
|
|
54
|
+
|
|
55
|
+
### Step 1: Export your API definition
|
|
56
|
+
|
|
57
|
+
AWS API Gateway supports exporting your API as an OpenAPI spec:
|
|
58
|
+
|
|
59
|
+
**Using the AWS Console:**
|
|
60
|
+
|
|
61
|
+
1. Navigate to your API in the API Gateway console.
|
|
62
|
+
2. Select **Stages** and choose the stage to export.
|
|
63
|
+
3. Go to the **Export** tab.
|
|
64
|
+
4. Select **OpenAPI 3** and **JSON** format.
|
|
65
|
+
5. Choose **Export as OpenAPI 3 + API Gateway Extensions** to include
|
|
66
|
+
integration details.
|
|
67
|
+
|
|
68
|
+
**Using the AWS CLI:**
|
|
69
|
+
|
|
70
|
+
```bash
|
|
71
|
+
aws apigateway get-export \
|
|
72
|
+
--rest-api-id YOUR_API_ID \
|
|
73
|
+
--stage-name prod \
|
|
74
|
+
--export-type oas30 \
|
|
75
|
+
--accepts application/json \
|
|
76
|
+
output.json
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
### Step 2: Clean up and import your OpenAPI spec
|
|
80
|
+
|
|
81
|
+
The exported spec includes AWS-specific extensions (`x-amazon-apigateway-*`)
|
|
82
|
+
that you need to replace with Zuplo configuration.
|
|
83
|
+
|
|
84
|
+
For each path and method, replace the `x-amazon-apigateway-integration` with
|
|
85
|
+
Zuplo's `x-zuplo-route` extension:
|
|
86
|
+
|
|
87
|
+
**AWS API Gateway export:**
|
|
88
|
+
|
|
89
|
+
```json
|
|
90
|
+
{
|
|
91
|
+
"/users": {
|
|
92
|
+
"get": {
|
|
93
|
+
"x-amazon-apigateway-integration": {
|
|
94
|
+
"type": "HTTP_PROXY",
|
|
95
|
+
"httpMethod": "GET",
|
|
96
|
+
"uri": "https://api.backend.example.com/users"
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
**Zuplo route configuration:**
|
|
104
|
+
|
|
105
|
+
```json
|
|
106
|
+
{
|
|
107
|
+
"/users": {
|
|
108
|
+
"get": {
|
|
109
|
+
"operationId": "get-users",
|
|
110
|
+
"summary": "List users",
|
|
111
|
+
"x-zuplo-route": {
|
|
112
|
+
"corsPolicy": "none",
|
|
113
|
+
"handler": {
|
|
114
|
+
"export": "urlForwardHandler",
|
|
115
|
+
"module": "$import(@zuplo/runtime)",
|
|
116
|
+
"options": {
|
|
117
|
+
"baseUrl": "https://api.backend.example.com"
|
|
118
|
+
}
|
|
119
|
+
},
|
|
120
|
+
"policies": {
|
|
121
|
+
"inbound": []
|
|
122
|
+
}
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Step 3: Map AWS integrations to Zuplo handlers
|
|
130
|
+
|
|
131
|
+
| AWS integration type | Zuplo handler |
|
|
132
|
+
| -------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
|
133
|
+
| HTTP / HTTP_PROXY | [URL Forward](../handlers/url-forward.md) or [URL Rewrite](../handlers/url-rewrite.md) |
|
|
134
|
+
| Lambda | [URL Forward](../handlers/url-forward.md) to Lambda function URL, or [AWS Lambda handler](../handlers/aws-lambda.md) |
|
|
135
|
+
| Mock | [Mock API policy](../policies/mock-api-inbound.md) |
|
|
136
|
+
|
|
137
|
+
### Step 4: Replace VTL mappings with TypeScript
|
|
138
|
+
|
|
139
|
+
If you use Velocity Template Language (VTL) for request/response
|
|
140
|
+
transformations, replace them with TypeScript custom code policies.
|
|
141
|
+
|
|
142
|
+
**AWS VTL mapping template:**
|
|
143
|
+
|
|
144
|
+
```velocity
|
|
145
|
+
#set($inputRoot = $input.path('$'))
|
|
146
|
+
{
|
|
147
|
+
"userId": "$inputRoot.id",
|
|
148
|
+
"fullName": "$inputRoot.first_name $inputRoot.last_name",
|
|
149
|
+
"email": "$inputRoot.email"
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
**Zuplo outbound custom code policy:**
|
|
154
|
+
|
|
155
|
+
```typescript
|
|
156
|
+
import { ZuploContext, ZuploRequest } from "@zuplo/runtime";
|
|
157
|
+
|
|
158
|
+
export default async function (
|
|
159
|
+
response: Response,
|
|
160
|
+
request: ZuploRequest,
|
|
161
|
+
context: ZuploContext,
|
|
162
|
+
options: never,
|
|
163
|
+
policyName: string,
|
|
164
|
+
) {
|
|
165
|
+
const data = await response.json();
|
|
166
|
+
|
|
167
|
+
const transformed = {
|
|
168
|
+
userId: data.id,
|
|
169
|
+
fullName: `${data.first_name} ${data.last_name}`,
|
|
170
|
+
email: data.email,
|
|
171
|
+
};
|
|
172
|
+
|
|
173
|
+
return new Response(JSON.stringify(transformed), {
|
|
174
|
+
status: response.status,
|
|
175
|
+
headers: response.headers,
|
|
176
|
+
});
|
|
177
|
+
}
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
### Step 5: Migrate Lambda authorizers
|
|
181
|
+
|
|
182
|
+
If you use Lambda authorizers for authentication, replace them with Zuplo's
|
|
183
|
+
built-in authentication policies or custom code policies.
|
|
184
|
+
|
|
185
|
+
**For API key authentication:**
|
|
186
|
+
|
|
187
|
+
Replace the Lambda authorizer + usage plan pattern with Zuplo's
|
|
188
|
+
[API Key Authentication](../policies/api-key-inbound.md) policy, which includes
|
|
189
|
+
built-in key management, a developer portal, and per-key rate limiting.
|
|
190
|
+
|
|
191
|
+
**For JWT / OAuth authentication:**
|
|
192
|
+
|
|
193
|
+
Replace the Lambda authorizer with one of Zuplo's JWT policies:
|
|
194
|
+
|
|
195
|
+
- [Auth0 JWT](../policies/auth0-jwt-auth-inbound.md)
|
|
196
|
+
- [AWS Cognito JWT](../policies/cognito-jwt-auth-inbound.md)
|
|
197
|
+
- [Firebase JWT](../policies/firebase-jwt-inbound.md)
|
|
198
|
+
- [Open ID JWT](../policies/open-id-jwt-auth-inbound.md) (generic OIDC)
|
|
199
|
+
|
|
200
|
+
:::note
|
|
201
|
+
|
|
202
|
+
You can continue using AWS Cognito as your identity provider. Use Zuplo's
|
|
203
|
+
[Cognito JWT Authentication](../policies/cognito-jwt-auth-inbound.md) policy to
|
|
204
|
+
validate Cognito tokens at the gateway.
|
|
205
|
+
|
|
206
|
+
:::
|
|
207
|
+
|
|
208
|
+
### Step 6: Replace usage plans with Zuplo rate limiting
|
|
209
|
+
|
|
210
|
+
AWS API Gateway's usage plans provide basic throttling and quota management.
|
|
211
|
+
Zuplo's rate limiting is more flexible:
|
|
212
|
+
|
|
213
|
+
| AWS usage plan feature | Zuplo equivalent |
|
|
214
|
+
| ---------------------------- | --------------------------------------------------------------------------- |
|
|
215
|
+
| Throttle rate (requests/sec) | [Rate Limiting](../policies/rate-limit-inbound.md) with `timeWindowMinutes` |
|
|
216
|
+
| Quota (requests/period) | [Quota policy](../policies/quota-inbound.md) |
|
|
217
|
+
| Per-key throttling | `rateLimitBy: "user"` on the rate limit policy |
|
|
218
|
+
| Burst limit | Built-in — Zuplo's sliding window handles bursts naturally |
|
|
219
|
+
|
|
220
|
+
### Step 7: Deploy and migrate traffic
|
|
221
|
+
|
|
222
|
+
1. Deploy your Zuplo project by pushing to your connected Git repository.
|
|
223
|
+
2. Set up a [custom domain](./custom-domains.md) for Zuplo.
|
|
224
|
+
3. Update your DNS to route traffic through Zuplo.
|
|
225
|
+
4. Zuplo can forward requests to your existing AWS backends (Lambda, ALB, ECS)
|
|
226
|
+
without changes.
|
|
227
|
+
5. Monitor traffic and gradually decommission your AWS API Gateway stages.
|
|
228
|
+
|
|
229
|
+
## Keeping AWS backends with Zuplo
|
|
230
|
+
|
|
231
|
+
You do not need to migrate your backend infrastructure. Zuplo works with any
|
|
232
|
+
HTTP backend, including:
|
|
233
|
+
|
|
234
|
+
- AWS Lambda (via function URLs or API Gateway pass-through)
|
|
235
|
+
- Application Load Balancers (ALB)
|
|
236
|
+
- Amazon ECS / EKS services
|
|
237
|
+
- Any AWS service with an HTTP endpoint
|
|
238
|
+
|
|
239
|
+
Use [backend security](./securing-your-backend.md) options like mTLS or shared
|
|
240
|
+
secrets to secure the connection between Zuplo and your AWS backends.
|
|
241
|
+
|
|
242
|
+
## Next steps
|
|
243
|
+
|
|
244
|
+
- [Set up your first Zuplo gateway](./step-1-setup-basic-gateway.md)
|
|
245
|
+
- [Add rate limiting](./step-2-add-rate-limiting.md)
|
|
246
|
+
- [Add API key authentication](./step-3-add-api-key-auth.md)
|
|
247
|
+
- [Configure your developer portal](../dev-portal/introduction.md)
|
|
248
|
+
- [Set up source control](./source-control.md)
|