Interface Contract Block
Document API and service interface contracts with operations, data types, constraints, and SLAs. Define clear agreements between service providers and consumers.
The Interface Contract block documents agreements between service providers and consumers. It captures the contract name, integration type, operations, data types, constraints, and service level agreements.
When to Use
Block Properties
| Property | Required | Description |
|---|---|---|
| Contract Name | Yes | Name of the interface contract |
| Integration Type | No | Type of integration: sync, async, or batch |
| Provider | No | Service exposing the interface |
| Consumer | No | Service using the interface |
| Operations | No | Array of operations with name, description, input, and output |
| Data Types | No | Array of shared data types used in the contract |
| Constraints | No | Array of limitations and requirements |
| SLA | No | Service level agreement terms |
Operation Properties
| Property | Required | Description |
|---|---|---|
| name | Yes | Operation identifier |
| description | No | What the operation does |
| input | No | Input data type or parameters |
| output | No | Output data type or response |
Integration Type Values
Example: Synchronous REST API Contract
A standard REST API contract for order management.
Example: Asynchronous Message Contract
An async contract for payment processing.
Example: Batch Integration Contract
A batch file transfer contract for reporting.