Your first spec in API Designer

From blank canvas to mock

API Designer in Exchange is a browser-based spec editor with live preview, inline validation, and one-click mocking.

A guided path

1. Create a new API spec in Exchange, choosing RAML or OAS.
2. Define resources and methods — start with the nouns (resources) and the verbs (methods) your consumers need.
3. Add data types / schemas so request and response shapes are explicit.
4. Toggle the mocking service to get a live base URL from the spec.
5. Share the mock with consumers and gather feedback before implementing.

What good looks like

• Clear, consistent resource naming (plural nouns, no verbs in paths).
• Documented error responses, not just the happy path.
• Examples on each response so the mock returns realistic data.

Coaching note

Encourage the customer's first spec to be small — one or two resources. A tiny spec that ships and gets mocked teaches the workflow faster than a large one that stalls in review.