Skip to content

// OpenAPI Import

Import an OpenAPI definition and start working immediately.

Bring a supported OpenAPI or Swagger definition into a shared model for Documentation, API Designer, Request Builder and SDK Generation.

Payments API / documentation / example preview
POST/payments

Creates a payment for an existing order.

ParametersRequestResponses
{
  "amount": 4900,
  "currency": "EUR"
}

Import one payment operation, reuse its context

Import the complete JSON example from the guide. The normalized POST /payments model provides documentation inputs, a Request Builder starting point and schemas for generated integration source. Use an actual API URL when sending requests; example.com is illustrative.

openapi.json -> Preview -> Save API Source
POST /payments
Request: amount (integer), currency (string)
Responses: 201 Created, 422 Unprocessable Content
Continue: Documentation / API Designer / Request Builder / SDK Generation
Follow the practical guide

Capabilities

OpenAPI Import capabilities

  • Upload a local JSON definition.
  • Import a supported OpenAPI or Swagger URL.
  • Connect a GitHub repository specification as an API Source.
  • Use normalized operations and schemas across workspace tools.

Workflow

Your openapi import workflow

01

Choose a source

Upload JSON, enter a supported definition URL or select a GitHub file.

02

Preview

Review the detected operations and resolve import errors.

03

Save

Save the source to make the normalized contract available in the workspace.

04

Work from the model

Browse Documentation, open a request or generate integration source code.

Built for real handoffs.

Existing APIs

Start from a maintained specification instead of re-entering every operation.

Frontend onboarding

Inspect POST /payments inputs and expected responses before integrating.

New designs

Choose manual API creation as a separate starting option when no definition exists and editing is permitted.

Related features

// FAQ

Questions, answered.

// GET STARTED

Bring your API workflow into one workspace.

Start with an OpenAPI or Swagger JSON definition and keep the workflow together.

Start for free