How to Use the Mock API Response Generator

Step 1: Select the HTTP Method

Click one of the method buttons — GET, POST, PUT, PATCH, or DELETE — to set the request method for your mock response. The method is displayed as a color-coded badge in the output for quick identification.

Step 2: Choose a Status Code

Pick an HTTP status code from the dropdown. Common codes are grouped by category: 2xx for success (200, 201, 204), 4xx for client errors (400, 401, 403, 404, 409, 422, 429), and 5xx for server errors (500, 502, 503). The status code updates automatically when you select a template.

Step 3: Select a Resource Type

Choose the type of resource the response should represent: User, Product, Order, Post, Comment, Subscription, or Invoice. The resource type controls the field names and values in the JSON body. Error templates use the resource name in their error messages.

Step 4: Pick a Response Template

Select from 12 response templates:

• Single Resource — a single JSON object wrapped in data
• Collection — an array of 3–6 records in data
• Paginated List — array with meta (total, page, per_page) and links
• Created — POST 201 response with the created object and a success message
• Deleted — DELETE 204 response with no body
• Validation Error — 422 with an error.details map of field-level errors
• Not Found — 404 with a structured error object
• Unauthorized — 401 with authentication error
• Forbidden — 403 with permissions error
• Server Error — 500 with error code and trace ID
• Rate Limited — 429 with retry_after field
• Conflict — 409 duplicate resource error

Selecting a template automatically updates the status code to the most appropriate value.

Step 5: Generate the Response

Click Generate Response. The tool builds a complete mock HTTP response in your browser and displays it in the output panel.

Step 6: Explore the Output Tabs

• Body — the formatted JSON response body
• Headers — all response headers (Content-Type, Date, X-Request-Id, Cache-Control, rate limit headers, etc.)
• Raw HTTP — the complete raw HTTP/1.1 response including status line, headers, and body, ready to paste into documentation or mock files

Step 7: Copy and Use

Click Copy to copy the currently active tab to your clipboard. Use the output in:

• API documentation (README, Swagger, Postman collections)
• Frontend mock data files
• Test fixtures and test helpers
• Demo environments and prototypes

Step 8: Regenerate for Fresh Values

Click Generate Response again to produce a new set of fake values — different UUIDs, names, dates, and numbers — while keeping the same template and settings.

Common Use Cases:

• API documentation: Include realistic response examples in README or Swagger files
• Frontend development: Use JSON body as mock data before the backend is ready
• Test fixtures: Generate expected response payloads for unit and integration tests
• Postman collections: Paste raw HTTP responses into mock server configurations
• Error handling: Generate 4xx/5xx responses to test frontend error handling UI
• Onboarding: Show new developers what a real API response looks like
• Demo environments: Create plausible fake data for screenshots and demos

Tips and Best Practices:

• Use Raw HTTP tab to copy a complete response ready for documentation
• X-Request-Id in headers is a unique UUID per generation — useful for tracing examples
• Regenerate multiple times to get varied values for collections and pagination
• The Validation Error template generates field-level errors based on the selected resource type
• Status code and template are independent — you can override the status to any value
• All data is synthetic and safe to share publicly