DEV Community

Cover image for 🚀 'GET' API in API Maker
API Maker®
API Maker®

Posted on

🚀 'GET' API in API Maker

#api #programming #backend #nocodesolution

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

Sample data table

customer_id first_name last_name last_update pincode isActive
1 Bob lin 2022-11-14 04: 34: 58 382345 1
2 Alice Page 2022-10-15 02: 10: 40 382346 1
3 Mallory Brown 2022-09-13 03: 44: 05 382347 1
4 Eve Mathly 2022-11-12 01: 59: 33 382348 1
5 Eve Page 2022-11-12 01: 59: 33 382349 1

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
Enter fullscreen mode Exit fullscreen mode
  • '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
Enter fullscreen mode Exit fullscreen mode

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

Get by multiple fields

?first_name=Bob&last_name=lin
Enter fullscreen mode Exit fullscreen mode

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,

Key Value
find ?find={first_name:'Bob'}
skip 2
limit 2
sort customer_id
select ?select=first_name,customer_id
deep ?deep=[{s_key:'customer_id,t_col: 'products',t_key:'owner_id'}]
getTotalCount true

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'}
Enter fullscreen mode Exit fullscreen mode 
?find={first_name:{$in:['Bob','Alice']}}
Enter fullscreen mode Exit fullscreen mode 
?find={customer_id:{$gte:3}}
Enter fullscreen mode Exit fullscreen mode

Skip data

  • It will skip the first 10 documents/rows. 
?skip=10
Enter fullscreen mode Exit fullscreen mode
  • It will skip the first 2 documents/rows having pinCode equals "382345" 
?pinCode=382345&skip=2
Enter fullscreen mode Exit fullscreen mode

Limit data

  • It will return only 10 documents/rows having first_name equals "Bob" 
?first_name=Bob&limit=10
Enter fullscreen mode Exit fullscreen mode

Sort data

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

ascending

?sort=customer_id
Enter fullscreen mode Exit fullscreen mode

descending

?sort=-customer_id
Enter fullscreen mode Exit fullscreen mode

Select data

  • It will return only first_name and last_name in response 
?select=first_name,last_name
Enter fullscreen mode Exit fullscreen mode

Deep data

  • It will return documents/rows from multiple table combinations. 
?deep=[{s_key:'customer_id,t_col: 'products',t_key:'owner_id'}]
Enter fullscreen mode Exit fullscreen mode

Here,

s_key = Source collection/table field
t_col = Target collection/table name
t_key = Target collection/table field
Enter fullscreen mode Exit fullscreen mode
  • 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]}}}]
Enter fullscreen mode Exit fullscreen mode

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
Enter fullscreen mode Exit fullscreen mode

Supported headers

Header Description
x-am-response-case It will change the response keys text as requested case. ```json "x-am-response-case": "camelCase" ``` noChange | camelCase | capitalCase | constantCase | dotCase | headerCase | noCase | paramCase | pascalCase | pathCase | sentenceCase | snakeCase
x-am-response-object-type To get flat response we use this request header. ```json "x-am-response-object-type": "make_flat" ``` no_action | make_flat
x-am-meta To get the meta-data of requested API. ```json "x-am-meta": "true" ``` false | true
x-am-secret Place secret id from API Maker. ```json "x-am-secret": "6381b80359bdbd3a87c9abd5" ```
x-am-internationalization We can get backend error messages in any user language and directly show them to the user in UI, so the user can take appropriate actions.
Provide saved internationalization name in request header. ```json "x-am-internationalization": "HINDI" ```
x-am-run-in-sandbox System will try to run requests in maximum provided sandbox, so if 1 provided every request will run in one sandbox, even if we have multiple sandbox with multiple API Maker instances. ```json "x-am-run-in-sandbox": "0" ```
x-am-content-type-response We can provide response type in request header. As provided header value we can expect the response type. ```json "x-am-content-type-response": "application/json" ``` application/json | text/xml | text/yaml
x-am-cache-control To reset the cache of the requested API manually and get fresh data, we can use 'x-am-cache-control' request header. ```json "x-am-cache-control": "reset_cache" ``` no_action | reset_cache
x-am-get-encrypted-data Encrypt response data and get in to the response. ```json "x-am-get-encrypted-data": "get_data_and_encryption" ``` no_encryption | get_only_encryption | get_data_and_encryption
x-am-authorization Provide token of API user in "x-am-authorization" header which will be generated from API Users inside API Maker. ```json "x-am-authorization": "eyJhbGciOiJIUzI1NiIsdlRrblJlcS" ```
x-am-user-authorization User token should be provided in 'x-am-user-authorization' header which will be generated based on some database user if required. ```json "x-am-user-authorization": "eyJhbGciOiJIpc1BydlRrblJlcS" ```
x-aws-authorization Provide AWS Cognito token in request header 'x-aws-authorization', if required. ```json "x-aws-authorization": "eyJhbGciOiJIUc1BdlRrlJlcS" ```
x-google-authorization Provide Google user token in request header 'x-google-authorization', if required. ```json "x-google-authorization": "eyJhbGceyJpc1BdlRrlJlcS" ```
x-azure-authorization Provide Azure active directory token in request header 'x-azure-authorization', if required. ```json "x-azure-authorization": "eyJhbGciOiJIUzI1NiIJpc1BdlRrlJlcS" ```
x-no-compression If user do not send 'x-no-compression' in request header, and response characters are more than value of "maxCharsResToCache" than the response will be compressed. ```json "x-no-compression": "true" ```
x-am-sandbox-timeout If any API did not give a response within given time, the sandbox will break and give a proper error message in the response. ```json "x-am-sandbox-timeout": "13000" // milliseconds ```
x-am-encrypted-payload When user sent encrypted payload, user must have to sent "x-am-encrypted-payload:true". ```json "x-am-encrypted-payload": "true" ```

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
Enter fullscreen mode Exit fullscreen mode

Override default primary key 

/api/schema/user-path/instance/database/table/get-by-id/382348/pincode
Enter fullscreen mode Exit fullscreen mode
  • 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

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

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
Enter fullscreen mode Exit fullscreen mode

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"
}
Enter fullscreen mode Exit fullscreen mode

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"
                        }
                    ]
                }
            ]
        }
    ]
}
Enter fullscreen mode Exit fullscreen mode

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"
                }
            ]
        }
    ]
}
Enter fullscreen mode Exit fullscreen mode

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
    }
}
Enter fullscreen mode Exit fullscreen mode

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

Top comments (0)

Read next

prince_beec5ccde00b7c6c73 profile image

Notice Board Realistic illusion using html css and javascript https://www.instagram.com/webstreet_code/

Prince -

leandroveiga profile image

Master Advanced LINQ in C#: Writing Ultra-Efficient Queries for Massive Datasets

Leandro Veiga -

bsorrentino profile image

From Audio to Diagram

bsorrentino -

githaiga22 profile image

Mastering Modern APIs with Go: From Basics to Best Practices🌐💻🚀

Allan Githaiga -