Skip to main content

Quick Start Guide

Build your first API in under 5 minutes

This comprehensive guide will walk you through creating a complete User Management API from scratch, including authentication, validation, and testing.

What You'll Build​

By the end of this guide, you'll have:

  • A complete database schema for user management
  • A fully functional REST API with authentication
  • Interactive API documentation
  • Tested endpoints ready for production

Complete Walkthrough​

Step 1: Create Your Account​

Sign Up for Free

Getting Started Steps:

  1. Visit Endora Platform — Go to endora.space
  2. Click "Get Started" — Start your free account
  3. Enter Your Details — Email, password, and basic information
  4. Verify Email — Check your inbox and click the verification link
Free Forever Plan

Start with our free plan that includes 100 requests/hour and 1 project. No credit card required.

Account Setup Video​

Step 2: Create Your First Project​

Project Setup

Project Creation Steps:

  1. Click "New Project" — From your dashboard
  2. Enter Project Name — "User Management API"
  3. Choose Database — PostgreSQL (recommended)
  4. Click "Create Project" — Your project is ready!

Project Dashboard Overview​

Your project dashboard includes:

  • Schema Builder — Visual database design tool
  • API Generator — One-click API generation
  • Testing Interface — Built-in API testing
  • Analytics — Usage and performance metrics

Project Creation Video​

Step 3: Design Your Database Schema​

Visual Schema Builder

Our drag-and-drop interface makes database design intuitive:

  1. Add Tables — Click "Add Table" to create new tables
  2. Define Columns — Set column names, types, and constraints
  3. Create Relationships — Connect tables with foreign keys
  4. Validate Schema — Check for errors and optimize design

User Management Schema​

For this tutorial, we'll create a simple user management system:

users table:

- id (Primary Key)
- email (text)
- name (text)
- password_hash (text)
- created_at (Timestamp)
- updated_at (Timestamp)
- is_active (Boolean)

Schema Creation Demo​

Step 4: Generate Your API​

One-Click API Generation

API Generation Process:

  1. Review Your Schema — Ensure everything looks correct
  2. Click "Generate API" — Endora creates all endpoints automatically
  3. Review Generated Endpoints — Check the created CRUD operations
  4. Configure Security — Set up authentication and permissions

Generated Endpoints​

Your API will include:

POST   /users          # Create new user
GET    /users          # List all users
GET    /users/{id}     # Get specific user
PUT    /users/{id}     # Update user
PATCH  /users/{id}     # Partial update
DELETE /users/{id}     # Delete user

API Generation Video​

Step 5: Test Your API​

Built-in Testing Interface

Testing Workflow:

  1. Go to API Docs — Navigate to API Docs throw side bar.
  2. Authenticate — Register or login user in /auth/register or /auth/register endpoints.
  3. Authorize — Copy access token and paste it in authorize interface.
  4. Test Endpoints — Test all you endpoints.
  5. View Responses — See real-time API responses

Testing Examples​

Create a User:

POST /users
{
  "email": "hengliza81@gmail.com",
  "name": "liza",
  "password": "Password123!"
}

Get All Users:

GET /users?page=1&limit=10

API Testing Video​

Next Steps​

Ready to build something amazing?

Start your next project