Skip to content
RESTTEST.

// API Designer

Design endpoints as structured contracts.

Define API operations in a structured editor, then use the same operation in documentation and Make Request.

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

Summary

Create a payment

Operation ID

createPayment
ParametersRequest bodyResponsesMocks
201 · Payment created
400 · Invalid request
401 · Unauthorized

Define POST /payments before implementing it

Model amount as an integer in minor currency units, currency as a string, and a 201 response. Add a 422 response for invalid amounts. Saved contracts feed Documentation and Request Builder. Export saved designs from Settings > Export OpenAPI; validation errors must be fixed first, and warnings need review.

POST /payments
Request: { "amount": 4900, "currency": "EUR" }
201: { "id": "pay_123", "amount": 4900, "currency": "EUR" }
422: { "code": "invalid_amount" }
Follow the practical guide

Capabilities

API Designer capabilities

  • Edit methods, paths and operation metadata.
  • Define query, path and header parameters.
  • Model request bodies, responses and examples.
  • Validate endpoint configuration before saving.
  • Configure multiple mock response variants.

Workflow

Your api designer workflow

01

Choose a source

Open an imported API or create a source in the workspace.

02

Define the operation

Set its method, path, parameters and request body.

03

Add responses

Describe status codes, headers, schemas and examples.

04

Use the contract

Browse it in Documentation or send it from Make Request.

Built for real handoffs.

API-first planning

Agree on paths, inputs and responses before implementation begins.

Contract maintenance

Update an operation in a focused editor when manual editing is enabled.

Failure modelling

Document validation, authorization and server error responses beside success cases.

Related features

API Documentation

Turn OpenAPI 3.x and Swagger 2.0 JSON definitions into structured, searchable reference material for your workspace.

Explore Mock Responses

Configure success and failure variants, then call enabled mocks through the authenticated hosted runtime while the backend is still being built.

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