DOCSEARCHbyAlgolia
Submit Docs

RestAPI.com Documentation

website·Indexed 31 days ago

https://docs.restapi.com

A serverless backend platform for building RESTful APIs without configuring servers or databases. Features include a Developer Portal for schema design, JavaScript serverless functions (HTTP and Timer), row-level security (RLS) via security policies, BLOB storage, and real-time capabilities using Azure Web PubSub and SignalR. Includes tools like the RestAPI Terminal (RAT) CLI and support for the Model Context Protocol (MCP) for AI assistants.

Tokens
57.1K
Snippets
250
Records
449
Agent score
51%

What's inside RestAPI.com

  1. Overview of RestAPI.com capabilities

    RestAPI.com is a managed backend-as-a-service that replaces traditional backend setup (servers, database design, manual API writing, and auth implementation) with a serverless, auto-scaling infrastructure. It provides a schema designer to auto-generate REST APIs, built-in identity providers for authentication, and automatic backups and maintenance.

  2. Overview of API Variants

    Variants allow for automatic, on-demand transformations of string or blob property values when accessed via the API. Transformed results are cached for performance and run on serverless infrastructure, removing the need for custom code to handle common transformations like image resizing or text translation.

  3. Overview of RestAPI.com Backend-as-a-Service

    RestAPI.com is a serverless, low-code backend-as-a-service (BaaS) that automatically generates a functional REST API, authentication, real-time sync, and hosting based on a defined data schema. The general workflow is: 1. Design a schema (via Developer Portal or JSON), 2. Receive instant REST endpoints for collections, 3. Connect a frontend via standard HTTP requests, and 4. Deploy via RestAPI.com hosting or a custom domain.

  4. Overview of RestAPI.com developer tools

    RestAPI.com provides a suite of tools for API development, testing, and automation available via the Developer Portal and a command-line interface:

    • REST Explorer: An interactive API client used for testing endpoints.
    • Data Explorer: A tool to browse, search, and edit collection data.
    • Create with AI: A feature to generate a starting schema when creating a new API.
    • Data Model: A visualizer for the database schema and its relationships.
    • JSON Definition: A tool for direct JSON editing of the API schema.
    • RestAPI Terminal (RAT): A command-line interface (CLI) used for deployment and CI/CD automation.
    • AI Assistants (MCP): A mechanism to connect AI assistants (such as Claude) to the application's data.

  5. Overview of RestAPI.com Views

    A view is a filtered subset of a collection. Unlike traditional database views, RestAPI.com views are fully updatable, supporting full CRUD operations (Create, Read, Update, Delete). Views allow developers to filter items based on criteria, limit the properties exposed to the API consumer, and implement fine-grained access control when combined with security rules.

  6. Overview of the Control Center for Business Tenants

    The Control Center is a tenant-wide command center available exclusively to administrators of Business tenants. It provides three primary administrative views:

    1. Monitoring: Side-by-side view of traffic, request-quota usage, and costs for every API in the tenant.
    2. Access Review: Audit of effective read/write permissions for roles and users across all APIs.
    3. Cost Management: Overview of the tenant's subscription and credit spend with per-API breakdowns.

    To access it, open your tenant and select the Control Center tab.

  7. Overview of REST Explorer features

    REST Explorer is an integrated API testing tool built into the Developer Portal that allows developers to test endpoints directly in the browser. Key capabilities include a visual request builder, a multi-tab interface for simultaneous testing, user context switching for access control testing, and export options for cURL and URLs.

  8. Overview of Business Tenant Governance Controls

    Business (Enterprise) tenants have access to a set of governance controls that operate across all APIs and applications in the tenant. These controls sit above individual API access rules and security policies. While most require a Business tenant, the IP allowlist is available to all tenant types.

  9. Overview of RestAPI.com backend capabilities

    RestAPI.com is a serverless, low-code backend-as-a-service (BaaS) that provides the following core build features:

    • Data Storage: Managed database with schema definition that automatically generates REST endpoints.
    • Authentication: Built-in identity providers including Microsoft, Google, and Facebook.
    • Functions: Serverless JavaScript functions for implementing custom business logic.
    • Hosting: Web app deployment to a global CDN with custom domain support.
    • Real-time: WebSocket-based subscriptions for instant data synchronization across clients.

  10. Implement real-time capabilities for live updates and communication

    Real-time capabilities can be used to implement the following use cases:

    • Live dashboards: Update metrics in real time.
    • Chat applications: Enable direct messaging between users.
    • Collaborative editing: Synchronize changes across multiple clients.
    • Notifications: Push updates directly to connected users.
    • Gaming: Synchronize game state in real time.
    • On-premise data: Use an agent on a customer's network to answer queries invoked by functions.

  11. Understand RestAPI.com Tenant structure

    A tenant is an organizational workspace in RestAPI.com that acts as a container for the following resources:

    • APIs: Your backend services.
    • Users: Team members with assigned access levels.
    • Support Tickets: Support requests associated with the APIs in that specific tenant.