Endpoint catalog
Organize operations by the task they support.
Start with a question ↗Capabilities
API development tools, with a clear point of view.
Explore endpoints, request examples and response behavior in a clear working reference. API Workbench keeps the contract understandable for the people building on either side of an interface.
Capabilities
API development tools, in focus.
Request examples
Show meaningful inputs and responses.
Start with a question ↗Error reference
Explain how a caller can recover.
Start with a question ↗A closer look
Document one operation well
An API reference needs more than field names. State what an operation changes, which inputs are required and how a client can distinguish a temporary problem from an invalid request.
Continue with the practical guide ↗Api Workbench
Discuss your workflow.
Write with a little context about api development tools and the question you would like to explore.
contact@api-workbench.lizh.cloud