DocsGetting Started

Documentation

Welcome to BuildIt. Learn how to configure mock API endpoints, leverage AI for bulk endpoint generation, and monitor incoming HTTP requests with live logs.

Introduction

BuildIt is a hosted API mocking platform designed to help frontend developers, full-stack engineers, and QA teams work independently of backend dependencies. You can instantly spin up real, publicly accessible HTTP endpoints that respond with custom status codes, headers, and JSON bodies.

Workspaces & Projects

Projects are logical workspaces used to group related mock API endpoints. They allow you to organize endpoints by microservice, client app, or staging environment.

The Default Project

To make getting started as seamless as possible, when you sign up, you automatically receive a default project. You do not need to perform any configuration. You can immediately begin creating endpoints inside this default workspace or create new projects as your architecture scales.

Creating Mock Endpoints

Within any project, you can add custom HTTP endpoints by defining the route path, HTTP method, and response payload.

Manual Configuration
Complete control over all parameters
Manually define the HTTP method (GET, POST, PUT, DELETE, etc.), target route path (e.g., /users or /users/:id), custom headers, HTTP status code (e.g., 200, 201, 400, 500), and write or paste the exact JSON response body.
AI-Assisted Responses
Generate data structures with natural language
If you are creating an endpoint manually but do not want to hand-craft mock data, you can ask the built-in AI generator to draft a realistic response payload matching your endpoint path (e.g. mock user profiles, e-commerce products, or nested logs).

AI Bulk Generation

Creating multiple mock endpoints by hand can be tedious. BuildIt allows you to spin up entire API schemas in seconds using natural language.

You can ask the AI to create multiple mock endpoints from a single prompt. For example, by typing:

"Create a full CRUD API for products and a separate endpoint to fetch shop metadata."

The AI engine automatically analyzes your request, deduces the correct HTTP methods, designs standard route schemas (including GET, POST, PUT, and DELETE routes), and writes corresponding mock JSON response payloads for each.

Interactive API Tester

You do not need to install terminal utilities or open external apps to verify your mocks are responding correctly.

You can test your APIs directly on the platform via the built-in Tester page (/tester). From the tester interface, select your mocked endpoint, input request query parameters or headers, specify a payload (for write operations), and hit send. The tester displays the HTTP status code, response time, and prettified JSON response immediately.

Monitoring: Logs & Dashboards

BuildIt keeps track of every request routed to your mock URLs, providing instant visibility into your application's communication.

Detailed Logs (/logs)

Visit the logs viewer to inspect real-time traffic. You can drill down into any request to inspect HTTP request headers, query strings, post bodies, and the exact response headers and payload returned to the client.

Analytical Dashboards

Every workspace features analytics dashboards. The dashboards summarize request frequency, request errors (such as 4xx or 5xx codes), average latency, and endpoint distribution over time, allowing you to gauge mock server usage at a glance.

Support & Help

Having trouble creating custom routing, configuring mock behaviors, or scaling project workspaces? We are here to help.

If you run into any issues, navigate to the Support page (/support). You can open a ticket, submit feature requests, or report unexpected behavior.

Go to SupportGo to Dashboard