Mock API Documentation

A compact static documentation hub for planning and using mock APIs with HttpStatus.

Getting started

Choose the product flow you need to unblock, write the route and response, then create the hosted mock on HttpStatus mocks. Keep the first mock narrow: one endpoint, one status code, one clear response.

Create mock API

Document method, path, request body, response body, headers, status code, and scenario. Add edge cases after the happy path works.

Import OpenAPI

Use OpenAPI or Swagger descriptions as planning documents. Convert the most important examples into hosted mock endpoints.

Mock status codes

Useful status codes include 200, 201, 204, 400, 401, 403, 404, 409, 422, 429, and 500.

Mock delays

Response delays help teams test loading states, skeleton screens, retries, and timeout messages.

Private mock APIs

When data is sensitive, avoid real customer records and use safe sample payloads. Keep private flows documented for the team that needs them.

Share mock APIs

Share the mock URL with the frontend app, QA suite, design prototype, or stakeholder demo. Include the scenario name so people know what behavior to expect.

Related links

Create a mock from the docs

Use the checklist, then create the live endpoint on HttpStatus.

Create Free Mock API