Skip to content
Mock APIs

Reference

OpenAPI spec

A machine-readable OpenAPI 3.0 description of every endpoint, schema, parameter, and example response.
Open openapi.json Swagger UI

Spec URL

OpenAPI 3.0 (JSON)
https://test.naimulhassan.me/openapi.json

The document describes API version 1.0.0 and uses the API's public base URL as its server, so generated clients point at the right host.

Always in sync

The API, this website, and the OpenAPI document are all generated from one shared package that defines the schemas and the endpoint registry. The example responses embedded in the spec and shown on these pages are captured by running the documented requests against the real API, and the test suite fails if they drift.

Importing

  • Postman: Import → Link → paste the spec URL. Postman creates a collection with every endpoint.
  • Insomnia: Create → Import → URL.
  • Code generators: point openapi-generator, openapi-typescript, or similar tools at the spec URL.
Generate TypeScript types
npx openapi-typescript https://test.naimulhassan.me/openapi.json -o mock-apis.d.ts

Authentication in the spec

Protected routes declare a demoBearer HTTP bearer security scheme. Get a token from demo login and paste it into your tool's bearer token field.

The spec is served with permissive CORS, so browser-based tools can load it directly. It is cached for five minutes.