API BLD

Quick Start Guide

Get up and running with apibld in just 5 minutes. This guide will walk you through creating your first model and API.

1

Create Your Account

Sign up for a free account and start your 14-day trial.

Start Free Trial
2

Create Your First Model

Models define the structure of your data. Let's create a simple "User" model.

From the Dashboard:

  1. Click the "New Model" button
  2. Name your model "User"
  3. Add fields to define user properties

Example User Model:

name→String (required)
email→Email (required, unique)
age→Number
isActive→Boolean

Pro Tip:

apibld supports 11 field types including String, Number, Email, URL, Date, and more. You can also set validation rules like min/max length, required, and unique.

3

Add Relationships (Optional)

Connect models together to create realistic data structures.

Example: User Posts

Create a "Post" model with fields:

title→String
content→Text
authorId→Relationship to User

Result: Each Post is linked to a User author

Learn more in the Relationships guide

4

Create Your API

Turn your models into a working REST API with mock data.

From the Dashboard:

  1. Click "Create API" button
  2. Name your API (e.g., "My First API")
  3. Select models to include (e.g., User, Post)
  4. Configure settings (CORS, persistence, authentication)
  5. Click "Generate API"

Success!

Your API is now live with automatically generated mock data.

5

Make Your First API Call

Test your API using cURL, Postman, or your favorite HTTP client.

Example API Call:

# Get all users
curl https://api.apibld.com/v1/your-api-id/users \
  -H "Authorization: Bearer your_api_key"

Example Response:

{
  "data": [
    {
      "id": "1",
      "name": "John Doe",
      "email": "john@example.com",
      "age": 28,
      "isActive": true
    },
    {
      "id": "2",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "age": 32,
      "isActive": true
    }
  ],
  "total": 2
}

Available Endpoints:

  • GET /users - List all
  • GET /users/:id - Get one
  • POST /users - Create
  • PUT /users/:id - Update
  • DELETE /users/:id - Delete

Query Parameters:

  • ?limit=10 - Limit results
  • ?offset=0 - Pagination
  • ?sort=name - Sort by field
  • ?filter[...] - Filter data

🎉 Congratulations!

You've successfully created your first API with apibld. Here's what to explore next:

Learn About Models

Explore all 11 field types and validation rules

Master Relationships

Create complex data structures with related models

Mock Data Generation

Customize how realistic test data is generated

OpenAPI Docs

Auto-generated API documentation and specs