Skip to content
RESTTEST.

// GitHub Synchronization

Keep your OpenAPI definition connected to GitHub.

Connect a repository specification, detect incoming updates and review them alongside local API changes.

Start for free Read documentation
Payments API / documentation / example preview
POST/payments

Creates a payment for an existing order.

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

Review a repository change to POST /payments

Select your repository, main branch and openapi.json file. After a commit adds a required currency field, check for updates and inspect the incoming operation. Resolve overlapping local edits before applying the update. This is an example workflow, not a live synchronization result.

Repository file: openapi.json
Branch: main
Operation: POST /payments
Incoming change: JSON request schema adds currency to required
Review: update callers and resolve any local conflict
Direction: GitHub -> REST Test
Follow the practical guide

Capabilities

GitHub Synchronization capabilities

  • Select a repository, branch and JSON or YAML specification file.
  • Preview the imported definition before saving the source.
  • Review incoming operation changes and resolve supported conflicts.
  • Configure checks within account quotas and plan scheduling limits.

Workflow

Your github synchronization workflow

01

Authorize

Connect a GitHub integration with installation access to the repository.

02

Select and import

Choose the branch and specification file, then preview and save the source.

03

Detect and review

Check for repository updates and compare incoming changes with local edits.

04

Resolve and apply

Resolve conflicts and apply reviewed updates. Automatic checks and auto-apply are separate settings.

Built for real handoffs.

Repository-owned contracts

Use the branch specification as the incoming API Source.

Integration handoffs

Refresh authenticated workspace documentation after reviewing a contract update.

Local design work

Inspect conflicts when local edits and repository changes affect the same definition.

Related features

OpenAPI Import

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

Explore API Change Review

Inspect source updates, compare local and incoming edits, resolve conflicts and browse retained API definition revisions.

Explore

// 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