Skip to content
Apiway Docs

Ship my API to production

You have an OpenAPI spec. You want it live — with governance, security, and monitoring already in place. Here’s how.

What you need

Section titled “What you need”
  • An Apiway tenant (register free — no card, and free credit to explore with; every capability is on every tier, so see pricing only for how much usage each one carries)
  • An OpenAPI 3.x specification (.yaml or .json)

The pipeline

Section titled “The pipeline”

  1. Upload your spec

    Terminal window
    curl -X POST https://core.api.apiway.net/v1/programmes \
      -H "Authorization: Bearer $TOKEN" \
      -H "Content-Type: application/json" \
      -d '{
        "name": "Payments API",
        "specification": "<base64-encoded OAS>"
      }'

  2. The platform takes over

    An 8-step automated pipeline runs:

    StepWhat happens
    ValidationChecks your spec against OpenAPI 3.x
    ComplianceScores against your organisation’s design standards
    RecommendationsSuggests improvements to your API design
    SecurityApplies OAuth 2.0, scopes, and entitlements automatically
    GovernanceSubmits for approval through your configured workflow
    DeploymentGenerates proxy and policy documents for your gateway
    SubscriptionCreates credentials for immediate use
    ActivationPromotes via blue-green revision swap

  3. Your API is live

    Terminal window
    curl https://alpha.gateway.apiway.net/payments-api-v1/transactions \
      -H "Authorization: Bearer $API_TOKEN"

    Security, rate limits, metering, and governance — all active from the first request.

What you got

Section titled “What you got”

Without writing a single line of configuration:

  • Governed — approval workflow completed, audit trail recorded
  • Secured — OAuth 2.0 with per-operation scopes enforced at the gateway
  • Metered — every request tracked as resource units for cost reporting
  • Versioned — blue-green deployment with rollback capability
  • Discoverable — listed in your API catalogue and developer portal

Already running for you: service levels enforced on every call · drift protection for your API and your consumers · breaking changes refused onto live versions · warnings when you under- or over-deliver on what you promised · risks raised as they happen.

Next steps

Section titled “Next steps”