Import
Upload a supported JSON definition or fetch one from a URL.
// API Documentation
Documentation that stays connected to the API.
Turn OpenAPI 3.x and Swagger 2.0 JSON definitions into structured, searchable reference material for your workspace.
Payments API / documentation / example preview
POST/payments
Creates a payment for an existing order.
ParametersRequestResponses
{
"amount": 4900,
"currency": "EUR"
}
"amount": 4900,
"currency": "EUR"
}
Give payment callers the contract they need
Browse POST /payments to find the required body, supported content type, success shape and validation failure. Workspace documentation requires member access; it is separate from this public product documentation.
Content-Type: application/json
amount: integer (minor units)
currency: string
201 Created -> payment object
422 Unprocessable Content -> validation errorCapabilities
API Documentation capabilities
- Browse endpoints by operation and method.
- Inspect parameters, request bodies and response schemas.
- Keep examples beside the API definition they describe.
- Use one normalized model across documentation and requests.
Workflow
Your api documentation workflow
Normalize
REST Test maps operations and schemas into a consistent internal model.
Browse
Explore endpoints, parameters, bodies, responses and examples.
Continue
Open an operation in Make Request or generate integration code.
Built for real handoffs.
Backend teams
Review operation contracts and examples without reading raw definition JSON.
Frontend teams
Find request inputs and response shapes before writing integration code.
API maintainers
Use a shared definition as the source for documentation, tests and generated clients.
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.