🚀 'GET' API in API Maker

Get APIs in detail made by API Maker
https://youtu.be/L8GqKGGEQjo
check YouTube video

Sample data table

GET ALL API

To get all the data of the collection/table use SCHEMA_GET_ALL API. API Maker provides multiple query params and headers options while getting all data.

URL

/api/gen/user-path/instance/database/table

• 'user-path' is the given API Maker user's API_PATH.
• 'instance' contains the instance name.
• 'database' contains the database name.
• 'table' contains the table/collection name.

Get by any field

/api/gen/user-path/instance/database/table?customer_id=1

You will get data which has 'customer_id' column value 1.

Get by multiple fields

?first_name=Bob&last_name=lin

You will get data which has 'first_name' column value 'Bob' and 'last_name' column value is 'lin'.

Supported query params

Here, API Maker supports below query parameters,

Find

valid JSON support for fetching data using find.

JSON 5 support

• It will return documents/rows as per JSON condition.

?find={first_name:'Bob'}

?find={first_name:{$in:['Bob','Alice']}}

?find={customer_id:{$gte:3}}

Skip data

• It will skip the first 10 documents/rows.

?skip=10

• It will skip the first 2 documents/rows having pinCode equals "382345"

?pinCode=382345&skip=2

Limit data

• It will return only 10 documents/rows having first_name equals "Bob"

?first_name=Bob&limit=10

Sort data

• It will sort documents/rows in order of ascending or descending

ascending

?sort=customer_id

descending

?sort=-customer_id

Select data

• It will return only first_name and last_name in response

?select=first_name,last_name

Deep data

• It will return documents/rows from multiple table combinations.

?deep=[{s_key:'customer_id,t_col: 'products',t_key:'owner_id'}]

Here,

s_key = Source collection/table field
t_col = Target collection/table name
t_key = Target collection/table field

• also use multiple query params [skip, limit, sort, find, etc...] in a single deep query.

?deep=[{s_key:'customer_id',t_col:'products',t_key:'owner_id',skip:1,isMultiple:true,limit:5,sort:'name',find:{category_id:{$in:[56572,89355]}}}]

GetTotalCount data

• It will return an additional parameter of 'totalCount' which indicate the total number of documents/rows get in to the response.

?getTotalCount=true

Supported headers

GET ALL BY STREAM API

• The only difference between 'get_all' and 'get_all_by_stream' API is that the stream API uses a streaming technique to send data from the server. When we are required to get huge amounts of data this API is used to send data in small chunks so the server will not have high memory spikes and the user can get data continuously.

GET BY ID API

• Provide two params 'id' and 'primaryKey'. This API always return a single document/row. more details

URL

/api/schema/user-path/instance/database/table/get-by-id/4

Override default primary key

/api/schema/user-path/instance/database/table/get-by-id/382348/pincode

• It will return a document/row having pincode 382348.
• In the above request 'pincode' is the overridden primary key and 382348 is the primary key value.

Supported query params

Supported headers

• All the headers which are available in the 'get_all' API will be supported in the 'get_by_id'.

Query for get data API

URL

/api/schema/user-path/instance/database/table/query

The request method of this API is POST. User need to provide payload to use this API. The body supports find, sort, skip, limit, select, deep, getTotalCount, groupBy keywords.

Sample request payload

{
    "find": {
        "owner_id": {
            "$in": [1, 2, 3]
        }
    },
    "skip": 1,
    "limit": 4,
    "sort": "price",
    "select": "name, owner_id, id, price",
    "deep": [
        {
            "s_key": "owner_id",
            "t_instance": "mysql",
            "t_db": "inventory",
            "t_col": "customers",
            "t_key": "customer_id",
            "find": {
                "first_name": "Billy"
            },
            "isMultiple": true,
            "limit": 10,
            "select": "customer_id,first_name",
            "skip": 2,
            "sort": "first_name"
        }
    ],
    "getTotalCount": true,
    "groupBy": "name"
}

Circular dependency

In API Maker if the user creates a circular dependency error to get deep data by mistake it will never make an issue any how.

Request payload

{
    "deep": [
        {
            "s_key": "owner_id",
            "t_col": "customers",
            "t_key": "customer_id",
            "deep": [
                {
                    "s_key": "customer_id",
                    "t_col": "products",
                    "t_key": "owner_id",
                    "select": "owner_id",
                    "deep": [
                        {
                            "s_key": "owner_id",
                            "t_col": "customers",
                            "t_key": "customer_id",
                            "select": "customer_id"
                        }
                    ]
                }
            ]
        }
    ]
}

Deep inheritance

Request payload

{
    "deep": [
        {
            "s_key": "price",
            "t_col": "orders",
            "t_key": "total",
            "select": "pincode",
            "deep": [
                {
                    "s_key": "shipping_id",
                    "t_col": "customers",
                    "t_key": "shipping_id",
                    "select": "phone"
                },
                {
                    "s_key": "shipping_id.pincode",
                    "t_col": "orders",
                    "t_key": "pincode"
                }
            ]
        }
    ]
}

find join example

• Set instance, database, collection and column in schema of the collection and provide only source key(s_key) to get deep data. more details.

{
    find: {
        "first_name.customer_id.shipping_id": 2
    }
}

Query for get data by stream API

• The only difference between 'query_for_get_data' and 'query_for_get_data_by_stream' APIs are that the stream API uses a streaming technique to send data from the server. When we are required to get huge amounts of data this API is used to send data in small chunks so the server will not have high memory spikes and the user can get data continuously.

To get more information about APIs please refer API Maker documentation.

Websites
https://apimaker.dev
https://cloud.apimaker.dev

Follow on twitter
https://twitter.com/api_maker

Linked In
https://www.linkedin.com/company/api-maker

Youtube Quick introduction video
https://youtu.be/_c6kEJJgfAw