Skip to content

API Maker Documentation

How to do local setup of API Maker

Initializing search

AM docs
Examples
Benchmarks
Blogs
Release notes
+ Extensions

API Maker Documentation

AM docs
AM docs
- API Maker All APIs List
  API Maker All APIs List
  - Generated-APIs
    Generated-APIs
    
    Get all
    
    Get all by stream
    
    Get by id
    
    Save single/multiple
    
    Master save/update single/multiple
    
    Array operations
    
    Update by id
    
    Update many
    
    Replace by id
    
    Remove by id
    
    Query for get data
    
    Query for get data by stream
    
    Remove by query
    
    Aggregate
    
    Count
    
    Distinct
    
    Distinct with query
  - Schema-APIs
    Schema-APIs
    
    Get all
    
    Get all by stream
    
    Get by id
    
    Save single/multiple
    
    Master save/update single/multiple
    
    Array operations
    
    Update by id
    
    Update many
    
    Replace by id
    
    Remove by id
    
    Query for get data
    
    Query for get data by stream
    
    Remove by query
    
    Aggregate
    
    Count
    
    Distinct
    
    Distinct with query
  - Custom-APIs
    Custom-APIs
    
    Custom api hello-world
  - System-APIs
    System-APIs
    
    Encrypt data
    
    Decrypt data
    
    Hash data
    
    Get token
    
    Call external API
    
    Get secret key/keys
    
    Get redis key/keys
    
    Set redis key/keys
    
    Remove redis key/keys
    
    Reset database cache
    
    Reset third party API cache
    
    Reset custom api cache
    
    Reset system apis cache
    
    Get table meta data
    
    Emit event
    
    Emit event WS
    
    Is valid data for table
    
    Is valid data for custom API
    
    Is valid data for third party API
  - Third-Party-APIs
    Third-Party-APIs
    
    API Maker store
    
    Third Party
  - Events
    Events
    
    Events
  - Scheduler
    Scheduler
    
    Scheduler
  - Utility classes
    Utility classes
    
    Utility
  - Hooks
    Hooks
    
    Pre-hook
    
    Post-hook
  - Header
    Header
    
    Request-header
  - Query Params
    Query Params
    
    List-of-query-params
    
    Find
    
    Skip
    
    Limit
    
    Sort
    
    Select
    
    Deep
    
    Get total count
- Pre defined terms
  Pre defined terms
  - Global object 'g.'
- Collection Schemas
  Collection Schemas
  - Table/Collection schema
- Connection Strings
  Connection Strings
  - Database wise string
    Database wise string
    
    Mongodb Connection Strings
    
    Mysql Connection Strings
    
    Postgres Connection Strings
    
    Mariadb Connection Strings
    
    Oracledb Connection Strings
    
    Sqlserver Connection Strings
- Authorization
  Authorization
- Settings
  Settings
- Secrets
  Secrets
  - Default secret
- APIs Security
  APIs Security
  - API group permission
  - API user permission
- Logs
  Logs
  - Log profile
  - Log table
- Internationalization
  Internationalization
  - i18n
- Dashboard
  Dashboard
- Git
  Git
  - Git hub feature
- Important features
  Important features
- AM Pages
  AM Pages
  - API Info
    API Info
    
    Database API
    
    Third party APIs
    
    Custom APIs
    
    Events
    
    Web socket events
    
    System APIs
    
    Schedulers
    
    API Testing
- AM resources | docs | videos
  AM resources | docs | videos
  - API Maker Configurations
Examples
Examples
- Auto generated APIs
  Auto generated APIs
  - Schema-APIs
    Schema-APIs
    
    Get all
    
    Get all by stream
    
    Get by id
    
    Save single/multiple
    
    Master save/update single/multiple
    
    Array operations
    
    Update by id
    
    Update many
    
    Replace by id
    
    Remove by id
    
    Query for get data
    
    Query for get data by stream
    
    Remove by query
    
    Aggregate
    
    Count
    
    Distinct
    
    Distinct with query
  - Generated-APIs
    Generated-APIs
    
    Get all
    
    Get all by stream
    
    Get by id
    
    Save single/multiple
    
    Master save/update single/multiple
    
    Array operations
    
    Update by id
    
    Update many
    
    Replace by id
    
    Remove by id
    
    Query for get data
    
    Query for get data by stream
    
    Remove by query
    
    Aggregate
    
    Count
    
    Distinct
    
    Distinct with query
  - System-APIs
    System-APIs
    
    All System APIs
    
    Encrypt data
    
    Decrypt data
    
    Hash data
    
    Get token
    
    Execute query
    
    Call external API
    
    Get secret key/keys
    
    Get table meta data
    
    Emit event
    
    Emit event WS
    
    Is valid data for table
    
    Is valid data for custom API
    
    Is valid data for third party API
  - Cache
    Cache
    
    Cache All
    
    Get redis key/keys
    
    Set redis key/keys
    
    Remove redis key/keys
    
    Reset database cache
    
    Reset custom api cache
    
    Reset system apis cache
    
    Reset third party API cache
- Custom APIs
  Custom APIs
  - custom API
- Request
  Request
  - Authorization
    Authorization
    
    Auth AM API user
    
    Auth AM database
    
    Auth AWS
    
    Auth Azure
    
    Auth Google
  - Body
    Body
    
    Request body
  - Event data
    Event data
    
    Request event data
  - Headers
    Headers
    
    Request headers
  - Params
    Params
    
    Request params
  - Query Params
    Query Params
    
    Request query params
- Response
  Response
  - Content type
    Content type
    
    All content type
    
    Html
    
    Json
    
    Text
    
    Yaml
    
    Xml
    
    Octet stream
  - Errors
    Errors
    
    Response error
  - Output
    Output
    
    Response output
  - Shared
    Shared
    
    Response error
  - Status code
    Status code
    
    Response status code
  - Warnings
    Warnings
    
    Response warnings
- Shared
  Shared
  - Global shared
- AM Features
  AM Features
  - Logger
    Logger
    
    Debug
    
    log
    
    warn
    
    error
    
    info
  - Schema
    Schema
    
    Schema
Benchmarks
Benchmarks
- Benchmarks Summary
  Benchmarks Summary
  - Linode
- Benchmarks Details
  Benchmarks Details
  - Linode
    Linode
    
    Shared CPU
    Shared CPU
    
    1 CPU | 1GB RAM
    1 CPU | 1GB RAM
    
    Get ALL | 10x10
    
    Get all with caching | 10x10
    
    GetAll By Stream
    
    Custom API
    
    Get By Id
    
    Get by ID with caching
    
    2 CPU | 4GB RAM
    2 CPU | 4GB RAM
    
    GetAll | 10x10
    
    Get all with caching | 10x10
    
    GetAll By Stream
    
    Custom API
    
    Get By Id
    
    Get by ID with caching
    
    4 CPU | 8GB RAM
    4 CPU | 8GB RAM
    
    GetAll | 10x10
    
    Get all with caching | 10x10
    
    GetAll By Stream
    
    Custom API
    
    Get By Id
    
    Get by ID with caching
    
    8 CPU | 32GB RAM
    8 CPU | 32GB RAM
    
    GetAll | 10x10
    
    Get all with caching | 10x10
    
    GetAll By Stream
    
    Custom API
    
    Get By Id
    
    Get by ID with caching
    
    Dedicated CPU
    Dedicated CPU
    
    2 CPU | 4GB RAM
    2 CPU | 4GB RAM
    
    Get ALL | 10x10
    
    Get all with caching | 10x10
    
    GetAll By Stream
    
    Custom API
    
    Get By Id
    
    Get by ID with caching
    
    4 CPU | 8GB RAM
    4 CPU | 8GB RAM
    
    Get ALL | 10x10
    
    Get all with caching | 10x10
    
    GetAll By Stream
    
    Custom API
    
    Get By Id
    
    Get by ID with caching
Blogs
Blogs
- Installation Blogs
  Installation Blogs
- General Blogs
  General Blogs
Release notes
Release notes
- Release Notes Summary
- v1.8.2
- v1.8.0
- v1.7.0
- v1.6.0
- v1.5.3
- v1.5.2
- v1.5.0
- v1.4.0
- v1.3.3
- v1.3.2
- v1.3.1
- v1.3.0
- v1.2.1
- v1.2.0
- v1.1.1
- v1.1.0
- v1.0.5
- v1.0.3
- v1.0.2
- v1.0.0
+ Extensions
+ Extensions
- ✹
  ✹
  - UI Maker
    UI Maker
    
    Introduction
    
    Getting Started
    
    Add More Fields In Grid
    
    Format Date In Grid
    
    Getting Started With Form
    
    Adding Date Field In Form
    
    Adding Checkbox Field In Form
    
    All Form Controls Config
    All Form Controls Config
    
    All Controls List
    
    input
    
    inputNumber
    
    inputMask
    
    inputOtp
    
    password
    
    date_picker
    
    textarea
    
    checkbox
    
    radio
    
    color_picker
    
    dropdown
    
    file_upload
    
    grid
    
    divider
    
    accordion
    
    tab_view
    
    button
    
    image
    
    customHTML
    
    Grid
    
    External CSS & JS via CDN
    
    Custom Global CSS & JS
    
    Code Separation From Config
    
    API Call Overrides
    
    CSV Import
    
    Export In CSV
    
    Themes
    
    Integrate Any Web App

How to do local setup of API Maker

You can follow steps from below repository.

GitHub

Previous Install API Maker in Server

Next Install Node.js 18 On Ubuntu Using NVM

API Maker Website