​
API Creation

The API Creation tool in CodeNull allows you to design and implement backend APIs for your web application without writing complex code. This guide walks you through the process of creating robust, scalable API endpoints that connect to your database and external services.

​
Overview

API Creation Interface
The API Creation interface provides an intuitive visual environment for designing your application’s backend services. It allows you to:
  • Define API endpoints with appropriate HTTP methods
  • Configure request and response schemas
  • Implement business logic using a visual flow editor
  • Connect endpoints to your database collections
  • Add authentication and authorization rules
  • Test your APIs in real-time

​
Creating Your First API

1

Navigate to the API Dashboard

From your CodeNull workspace, click on “API Dashboard” in the left navigation panel.
2

Create a New API

Click the “Create New API” button in the top-right corner of the dashboard.
3

Define API Details

Enter the basic information for your API:
  • API Name: A descriptive name for your API (e.g., “Product Management”)
  • Base Path: The root URL path for your API (e.g., “/api/products”)
  • Description: A brief explanation of what your API does
4

Configure API Settings

Set global options for your API:
  • Authentication: Choose authentication method (None, API Key, JWT, OAuth)
  • Rate Limiting: Configure request limits to prevent abuse
  • CORS Settings: Specify allowed origins and methods
  • Response Format: Define standard response structure
5

Save API Configuration

Click “Create API” to generate your API structure. You’ll be redirected to the endpoint management screen where you can add specific endpoints.

​
API Configuration Options

API Authentication Configuration
Choose from multiple authentication options:
  • No Authentication: Publicly accessible API
  • API Key: Simple key-based authentication
  • JWT: JSON Web Token authentication
  • OAuth 2.0: Industry-standard protocol for authorization
For each method, you can configure specific settings such as token expiration, key rotation policies, and scope definitions.

​
Connecting to Data Sources

Your API can connect to various data sources:

MongoDB Collections

Connect to your NoSQL database collections

SQL Tables

Link to relational database tables

External APIs

Integrate with third-party API services

Serverless Functions

Execute custom serverless functions

Static Data

Use static JSON or CSV data

Real-time Sources

Connect to WebSockets or SSE

​
Best Practices

Follow these best practices when creating APIs:
  • Use RESTful conventions: Follow REST principles for intuitive API design
  • Consistent naming: Use consistent patterns for endpoint URLs
  • Proper status codes: Return appropriate HTTP status codes
  • Versioning: Include version information in your API paths
  • Input validation: Validate all input data to prevent errors and security issues
  • Response formatting: Maintain consistent response structure

​
Next Steps

Endpoints Management

Learn how to create and manage specific API endpoints

Database Integration

Explore how to connect your API to database resources