Page History

...

We define some of convention way to mapping from a data source to resource's properties

Map resource's properties by naming convention:
If the data source has key same with the property name. It's auto mapped

Map with User Resource
If the data source has a set of "user_" prefix key and `user` property, It auto combine field to UserResource and Map to user property of the current resource

Manual mapping
We can override or manual mapping fields use Setter and Getter methods. Setter method uses to control input data, Getter control the output. The naming convention of setter & getter methods follow examples bellow

...

Postman is one of a good application for testing APIs.
Here are the API patterns to access Posts app

GET url

Or get Edit form response
GET url{

{

{
{

{
{

true,

},
{

true,

},
{

null,
null,

}
}
},
{

{
{

true,

[
{
1,

},
{
2,

},
{
3,

}
],

},
{

},
{

null,

}
}
},
{

{
{

0,

[
{

"value": 0
},
{
"label": "Friends",
"value": 1
},
{
"label": "Friends of Friends",
"value": 2
},
{
"label": "Only Me",
"value": 3
},
{
"label": "Custom",
"value": 4
}
],
"label": "Privacy",
"multiple": false,
"description": "Control who can see this post"
}
}
}
},
"fields": {
"module_id": {
"name": "module_id",
"component_name": "Hidden",
"value": "post"
},
"item_id": {
"name": "item_id",
"component_name": "Hidden"
},
"draft": {
"name": "draft",
"component_name": "Checkbox",
"value": 0,
"label": "Save as Draft"
},
"submit": {
"name": "submit",
"component_name": "Submit",
"label": "Publish",
"value": 1
}
}
}
}DELETE url

Pattern description ex. response

Code Block

language	bash

GET {{url}}/restful_api/mobile/post?access_token={{token}}

Get List of Posts

{

Code Block

language	js
collapse	true

{
    "status": "success",


    "data":

[
{

 [
        {
            "resource_name": "post",


            "title": "Title of the post",


            "description": "Description of the post",


            "module_id": "post",


            "item_id": 0,


            "is_approved": true,


            "is_sponsor": false,


            "is_featured": false,


            "is_liked": null,


            "is_friend": null,


            "post_status": 1,


            "image": null,


            "statistic":

{

 {
                "total_like": 0,


                "total_comment": 0,


                "total_view": 1,


                "total_attachment":

0
},

 0
            },
            "privacy": 0,


            "user":

{

 {
                "full_name": "Cute User",


                "avatar": null,


                "id":

1
},

 1
            },
            "categories":

[
{

 [
                {
                    "id": 6,


                    "name": "Recreation"

}
],


                }
            ],
            "tags": [],


            "attachments": [],


            "id": 1,


            "creation_date": "2018-11-30T04:44:39+00:00",


            "modification_date": null,


            "link": "http://localhost:7788/post/1/love/",


            "extra":

{

 {
                "can_view": true,


                "can_like": true,


                "can_share": true,


                "can_delete": true,


                "can_report": false,


                "can_add": true,


                "can_edit": true,


                "can_comment": true,


                "can_publish": false,


                "can_feature": true,


                "can_approve": true,


                "can_sponsor": true,


                "can_sponsor_in_feed": false,


                "can_purchase_sponsor":

true
},

 true
            },
            "self": null,


            "links":

null
}
]
}GET url

 null
        }
    ]
}

Code Block

language	bash

GET {{url}}/restful_api/mobile/post/1?access_token={{token}}

Get Post Detail

Expand source
{

Code Block

language	js
collapse	true

{
    "status": "success",


    "data":

{

 {
        "resource_name": "post",


        "title": "Title of the post",


        "description": "Description of the post",


        "module_id": "post",


        "item_id": 0,


        "is_approved": true,


        "is_sponsor": false,


        "is_featured": false,


        "is_liked": false,


        "is_friend": false,


        "post_status": 1,


        "text": "xxxx",


        "image": null,


        "statistic":

{

 {
            "total_like": 0,


            "total_comment": 0,


            "total_view": 1,


            "total_attachment":

0
},

 0
        },
        "privacy": 0,


        "user":

{

 {
            "full_name": "Cute User",


            "avatar": null,


            "id":

1
},

 1
        },
        "categories":

[
{

 [
            {
                "id": 6,


                "name": "Recreation"

}
],


            }
        ],
        "tags": [],


        "attachments": [],


        "id": 1,


        "creation_date": "2018-11-30T04:44:39+00:00",


        "modification_date": null,


        "link": "http://localhost:7788/post/1/love/",


        "extra":

{

 {
            "can_view": true,


            "can_like": true,


            "can_share": true,


            "can_delete": true,


            "can_report": false,


            "can_add": true,


            "can_edit": true,


            "can_comment": true,


            "can_publish": false,


            "can_feature": true,


            "can_approve": true,


            "can_sponsor": true,


            "can_sponsor_in_feed": false,


            "can_purchase_sponsor":

true
},

 true
        },
        "self": null,


        "links":

{

 {
            "likes":

{

 {
                "ref": "mobile/like?item_type=post&item_id=1"

},


            },
            "comments":

{

 {
                "ref": "mobile/comment?item_type=post&item_id=1"

}
},


            }
        },
        "feed_param":

{

 {
            "item_id": 1,


            "comment_type_id": "post",


            "total_comment": 0,


            "like_type_id": "post",


            "total_like": 0,


            "feed_title": "Love",


            "feed_link": "http://localhost:7788/post/1/love/",


            "feed_is_liked": false,


            "feed_is_friend": false,


            "report_module": "post"

}

}
}


        }
    }
}

Code Block

language	bash

GET {{url}}/restful_api/mobile/post/form/?access_token={{token

}}
 
# Or get Edit form response
GET {{url}}/restful_api/mobile/post/form/1?access_token={{token}}

Get create post form

Code Block

language	js
collapse	true

{
    "status": "success",


    "data":

 {
        "title": "Add a new post",


        "description": "",


        "action": "mobile/post",


        "method": "post",


        "sections":

 {
            "basic":

 {
                "label": "Basic Info",


                "fields":

 {
                    "title":

 {
                        "name": "title",


                        "component_name": "Text",


                        "required":

 true,
                        "value": "",


                        "returnKeyType": "next",


                        "label": "Title",


                        "placeholder": "Fill title for post"


                    },
                    "text":

 {
                        "name": "text",


                        "component_name": "TextArea",


                        "required":

 true,
                        "value": "",


                        "returnKeyType": "default",


                        "label": "Post",


                        "placeholder": "Add content to post"


                    },
                    "attachment":

 {
                        "name": "attachment",


                        "component_name": "Attachment",


                        "label": "attachment",


                        "item_type": "post",


                        "item_id":

 null,
                        "current_attachments":

 null,
                        "upload_endpoint": "mobile/attachment"


                    }
                }
            },
            "additional_info":

 {
                "label": "Additional Info",


                "fields":

 {
                    "categories":

 {
                        "name": "categories",


                        "component_name": "Choice",


                        "multiple":

 true,
                        "value": [],


                        "label": "Categories",


                        "value_type": "array",


                        "options":

 [
                            {
                                "value":

 1,
                                "label": "Business"


                            },
                            {
                                "value":

 2,
                                "label": "Education"


                            },
                            {
                                "value":

 3,
                                "label": "Entertainment"


                            }
                        ],
                        "suboptions": []


                    },
                    "tags":

 {
                        "name": "tags",


                        "component_name": "Tags",


                        "value": "",


                        "returnKeyType": "next",


                        "label": "Topics",


                        "description": "Separate multiple topics with commas."


                    },
                    "file":

 {
                        "name": "file",


                        "component_name": "File",


                        "label": "Photo",


                        "file_type": "photo",


                        "item_type": "post",


                        "preview_url":

 null,
                        "upload_endpoint": "mobile/file"


                    }
                }
            },
            "settings":

 {
                "label": "Settings",


                "fields":

 {
                    "privacy":

 {
                        "name": "privacy",


                        "component_name": "Privacy",


                        "value":

 0,
                        "returnKeyType": "next",


                        "options":

 [
                            {
                                "label": "Everyone",


                                "value": 0
                            },
                            {
                                "label": "Friends",
                                "value": 1
                            },
                            {
                                "label": "Friends of Friends",
                                "value": 2
                            },
                            {
                                "label": "Only Me",
                                "value": 3
                            },
                            {
                                "label": "Custom",
                                "value": 4
                            }
                        ],
                        "label": "Privacy",
                        "multiple": false,
                        "description": "Control who can see this post"
                    }
                }
            }
        },
        "fields": {
            "module_id": {
                "name": "module_id",
                "component_name": "Hidden",
                "value": "post"
            },
            "item_id": {
                "name": "item_id",
                "component_name": "Hidden"
            },
            "draft": {
                "name": "draft",
                "component_name": "Checkbox",
                "value": 0,
                "label": "Save as Draft"
            },
            "submit": {
                "name": "submit",
                "component_name": "Submit",
                "label": "Publish",
                "value": 1
            }
        }
    }
}

Code Block

language	bash

DELETE {{url}}/restful_api/mobile/post/{{post_id}}?access_token={{token}}

Delete a Post

Page tree

Versions Compared

Old Version 9

New Version Current

Key