Documentation/API Builder

API Builder

Alpha Testing

Build, deploy, and manage production-ready APIs with our GUI based low-code platform. Create RESTful & Graph APIs in minutes, not hours.

Overview

API Builder is OmNave's powerful low-code platform for creating, deploying, and managing APIs. Whether you're building a simple CRUD API or a complex microservices architecture, API Builder provides the tools you need to get your APIs up and running quickly.

With API Builder, you can:

  • Create RESTful APIs using a visual interface or code
  • Connect to multiple database types (PostgreSQL, MySQL, MongoDB, etc.)
  • Implement authentication and authorization out of the box
  • Auto-generate API documentation with Swagger/OpenAPI
  • Monitor API performance and usage in real-time
  • Deploy APIs with a single click

Alpha Testing Notice

API Builder is currently in Alpha Testing. Features may change and some functionality may be limited. We welcome your feedback to help improve the platform.

Key Features

Visual API Designer

Design your APIs visually with our drag-and-drop interface. Define endpoints, request/response schemas, and business logic without writing code.

Auto-Generated Documentation

Automatically generate interactive API documentation with Swagger UI. Keep your docs in sync with your API code.

Built-in Authentication

Secure your APIs with JWT tokens, API keys, OAuth 2.0, or custom authentication. Role-based access control included.

Rate Limiting & Throttling

Protect your APIs from abuse with configurable rate limiting. Set limits per user, IP, or API key.

Real-time Monitoring

Monitor API performance, track requests, and identify bottlenecks with our built-in analytics dashboard.

One-Click Deployment

Deploy your APIs to our managed infrastructure with a single click. Auto-scaling and high availability included.

Quick Start

Get started in 5 minutes

1

Sign in to API Builder

Access API Builder from your OmNave dashboard or go directly to the platform.

Open API Builder →
2

Create a New Service

Click "Create Service" and give your API service a name. Choose a template or start from scratch.

3

Connect Your Database

Add a database connection. API Builder supports PostgreSQL, MySQL, MongoDB, and more. You can also use our managed database.

4

Define Your APIs

Create API endpoints using the visual designer or write custom code. Define your data models, routes, and business logic.

5

Deploy & Test

Click "Deploy" to publish your API. Use the built-in API tester or Swagger UI to test your endpoints.

Creating APIs

API Builder provides two ways to create APIs: using the Visual Designer or writing custom code.

Using the Visual Designer

The Visual Designer lets you create APIs without writing code. Simply:

  1. Navigate to the API Designer tab
  2. Click "Add Endpoint" to create a new route
  3. Select the HTTP method (GET, POST, PUT, DELETE, etc.)
  4. Define the request parameters and body schema
  5. Configure the response schema
  6. Add any middleware (authentication, validation, etc.)

Writing Custom Code

For more complex logic, you can write custom code using JavaScript/TypeScript:

Example: Custom GET endpoint
// GET /api/users/:id
export async function getUser(req, res) {
  const { id } = req.params;

  try {
    const user = await db.users.findById(id);

    if (!user) {
      return res.status(404).json({
        error: 'User not found'
      });
    }

    return res.json(user);
  } catch (error) {
    return res.status(500).json({
      error: 'Internal server error'
    });
  }
}

Authentication

API Builder supports multiple authentication methods out of the box:

JWT Tokens

Secure your APIs with JSON Web Tokens. Configure token expiration, refresh tokens, and custom claims.

API Keys

Generate and manage API keys for server-to-server communication. Set permissions and rate limits per key.

OAuth 2.0

Integrate with OAuth 2.0 providers like Google, GitHub, or custom providers.

Role-Based Access

Define roles and permissions to control access to specific endpoints.

Database Integration

API Builder integrates with popular databases. Connect to your existing database or use our managed database service.

Supported Databases

PostgreSQL
MySQL
MongoDB
Redis
SQLite
MariaDB
Oracle
SQL Server

Deployment

Deploy your APIs with a single click. API Builder handles infrastructure, scaling, and SSL certificates automatically.

Deployment Options

  • Managed Deployment - Deploy to our fully managed infrastructure
  • Self-Hosted - Export and deploy to your own servers
  • Docker - Generate Docker images for containerized deployments

Monitoring

Monitor your API performance and usage with our built-in analytics dashboard.

Request Metrics

Track total requests, response times, and error rates in real-time.

Usage Analytics

See which endpoints are most used and identify usage patterns.

Error Tracking

Get detailed error logs and stack traces for debugging.

API Reference

Explore the complete API reference for API Builder, including all available endpoints, parameters, and response formats.

Need Help?

Our team is here to help you get the most out of API Builder. Reach out if you have questions or need assistance.