Skip to content

Basic Workflow

The typical workflow in API Dev Studio:

  1. Create a mock endpoint - Define the path, method, and response
  2. Test it - Make requests to your mock server
  3. Inspect requests - View logged requests in the Request Inspector
  4. Iterate - Refine your mocks based on what you learn

Create Your First Endpoint

  1. With your project selected, click Create Mock
  2. Set the path: /api/users
  3. Set the method: GET
  4. In the response body, enter:
[
  { "id": 1, "name": "Alice" },
  { "id": 2, "name": "Bob" }
]
  1. Click Save (or changes auto-save after a moment)

Test Your Endpoint

curl http://localhost:3001/api/users

You'll see your mock response!

View in Request Inspector

  1. Click Requests in the sidebar
  2. See your curl request logged with full details
  3. Click a request to view headers, body, and response

Next Steps