Does this tool connect to my OCI account?

No. This tool runs entirely in your browser and generates configuration JSON that you can copy and paste into your infrastructure-as-code templates, CLI commands, or cloud console. It never connects to any cloud account or sends data externally.

Are the generated configurations production-ready?

The tool produces syntactically valid configurations based on current OCI service specifications. Always review generated configs against your organization security policies and test in a non-production environment before deploying.

OCI API Deployment Route Builder

ServerlessOCI

Build API Gateway detailed route configurations with JWT authentication and rate limiting.

OCI API Gateway Configuration

Build API Gateway detailed route configurations with JWT authentication, rate limiting, CORS, and backend routing.

Required Fields

compartmentIdgatewayIddisplayNamepathPrefixspecification.routes

{
  "compartmentId": "ocid1.compartment.oc1..aaaaaaaexample",
  "gatewayId": "ocid1.apigateway.oc1.iad.aaaaaaaexample",
  "displayName": "prod-api-deployment-v2",
  "pathPrefix": "/api/v2",
  "specification": {
    "requestPolicies": {
      "authentication": {
        "type": "JWT_AUTHENTICATION",
        "tokenHeader": "Authorization",
        "tokenAuthScheme": "Bearer",
        "issuers": ["https://identity.oraclecloud.com/"],
        "audiences": ["https://api.example.com"],
        "publicKeys": {
          "type": "REMOTE_JWKS",
          "uri": "https://identity.oraclecloud.com/.well-known/jwks.json",
          "maxCacheDurationInHours": 1
        },
        "verifyClaims": [
          { "key": "scope", "values": ["api:read", "api:write"], "isRequired": true }
        ]
      },
      "rateLimiting": {
        "rateInRequestsPerSecond": 100,
        "rateKey": "CLIENT_IP"
      },
      "cors": {
        "allowedOrigins": ["https://app.example.com"],
        "allowedMethods": ["GET", "POST", "PUT", "DELETE", "OPTIONS"],
        "allowedHeaders": ["Authorization", "Content-Type"],
        "maxAgeInSeconds": 3600,
        "isAllowCredentialsEnabled": true
      },
      "mutualTls": {
        "isVerifiedCertificateRequired": false,
        "allowedSans": ["*.example.com"]
      }
    },
    "routes": [
      {
        "path": "/users",
        "methods": ["GET"],
        "backend": {
          "type": "HTTP_BACKEND",
          "url": "https://users-service.internal:8080/api/users",
          "connectTimeoutInSeconds": 10,
          "readTimeoutInSeconds": 30,
          "sendTimeoutInSeconds": 30
        },
        "requestPolicies": {
          "authorization": {
            "type": "ANY_OF",
            "allowedScope": ["api:read"]
          },
          "headerTransformations": {
            "setHeaders": {
              "items": [
                { "name": "X-Request-Id", "values": ["${request.headers[X-Request-Id]}"] }
              ]
            }
          }
        }
      },
      {
        "path": "/users/{userId}",
        "methods": ["GET", "PUT", "DELETE"],
        "backend": {
          "type": "HTTP_BACKEND",
          "url": "https://users-service.internal:8080/api/users/${request.path[userId]}"
        },
        "requestPolicies": {
          "authorization": {
            "type": "ANY_OF",
            "allowedScope": ["api:read", "api:write"]
          }
        }
      },
      {
        "path": "/webhook",
        "methods": ["POST"],
        "backend": {
          "type": "ORACLE_FUNCTIONS_BACKEND",
          "functionId": "ocid1.fnfunc.oc1.iad.aaaaaaaexample"
        },
        "requestPolicies": {
          "authorization": { "type": "ANONYMOUS" }
        }
      }
    ],
    "loggingPolicies": {
      "accessLog": { "isEnabled": true },
      "executionLog": { "isEnabled": true, "logLevel": "INFO" }
    }
  },
  "freeformTags": {
    "api-version": "v2",
    "team": "api-platform"
  }
}

Generated Output

Output will appear here...

About This Tool

Build API Gateway detailed route configurations with JWT authentication and rate limiting. This tool helps OCI engineers generate valid configurations quickly without consulting documentation, reducing errors and accelerating infrastructure deployment. All processing runs in your browser with no data sent to external servers.

When to Use This Tool

•Generating oci api deployment route configurations for new infrastructure deployments.
•Validating existing configurations against best practices before applying changes.
•Learning OCI service configuration patterns through interactive examples.
•Accelerating infrastructure-as-code development by producing correct JSON/YAML starting points.

Frequently Asked Questions

Does this tool connect to my OCI account?: No. This tool runs entirely in your browser and generates configuration JSON that you can copy and paste into your infrastructure-as-code templates, CLI commands, or cloud console. It never connects to any cloud account or sends data externally.
Are the generated configurations production-ready?: The tool produces syntactically valid configurations based on current OCI service specifications. Always review generated configs against your organization security policies and test in a non-production environment before deploying.

Related Learning Guides

OCI Streaming & Events22 min read
OCI Functions: Serverless Guide22 min read

Disclaimer: This tool runs entirely in your browser. No data is sent to our servers. Always verify outputs before using them in production. AWS, Azure, and GCP are trademarks of their respective owners.