Create an operation
Define POST /payments in API Designer where manual editing is enabled.
// OpenAPI Export
Generate OpenAPI JSON from your API design.
Design and refine your API visually, then export its saved definition as a portable OpenAPI JSON specification.
Payments API / designer / example preview
POST/payments
Summary
Create a payment
Operation ID
createPayment
ParametersRequest bodyResponsesMocks
201 · Payment created
400 · Invalid request
401 · Unauthorized
Export a saved Payments API contract
This minimal complete document illustrates a 201 response contract. A real export reflects your saved schemas and operation metadata. Inspect warnings before using the output in another tool.
{
"openapi": "3.0.3",
"info": {
"title": "Payments API",
"version": "1.0.0"
},
"paths": {
"/payments": {
"post": {
"operationId": "createPayment",
"responses": {
"201": {
"description": "Payment created"
}
}
}
}
}
}Capabilities
OpenAPI Export capabilities
- Export the saved workspace definition as OpenAPI JSON.
- Carry operation parameters, request bodies and responses into other tools.
- Fix reported validation errors before downloading.
- Review warnings about information that cannot be represented completely.
Workflow
Your openapi export workflow
Define schemas
Describe the JSON request body, a 201 payment response and a validation error.
Save
Save pending changes; export reads the saved definition.
Export
Open Settings > Export OpenAPI, review validation and download JSON.
Built for real handoffs.
Frontend contracts
Share request and response shapes before the payment backend is ready.
Backend implementation
Review the designed operations alongside server code and tests.
Tool portability
Pass the JSON specification to compatible documentation and code generation tools.
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.