API Endpoints

<column-name> mentioned in the endpoints below is refereed to the comments table's column name in the database.

Demo

Test the endpoints below online by replacing http://127.0.0.1:8000/api with the following URL:

https://over-demo.herokuapp.com/api

Get Comments

GET http://127.0.0.1:8000/api/comments/get

This endpoint allows you to get comments by the given query parameters (single/multiple) with filtering and pagination, If no parameter given, it will return all the comments in the database.

Query Parameters

Name	Type	Description
comment_id	string	[For get replies]: comment_id means reply_id column in the database, it is used to get all the comments that have a reply_idequal to the given comment_id
id	string	Find comments matching the given id Ex:?id=xxxxxx
commentable_key	string	Find comments matching the given commentable_key Ex: ?commentable_key=xxxxxx
commentable_id	string	Find comments matching the given commentable_id Ex: ?commentable_id=xxxxxx
filter	string	Ordering the incoming comment's data by <column-name>, <SORT> <SORT> = ASC / DESC It is optional and it's default value = ASC Ex:?filter=id,DESC or ?filter=id
page	number	Paginate the incoming comment's data Ex: ?page=1
per_page	number	Specify the limit of data (per page) for pagination. The default is 10 per page. Ex: ?per_page=3

200 Comments successfully retrieved.

// Without pagination
{
    "data": [
        ...
        ...
    ]
}

// with pagination
{
    "data": [
        ...
        ...
    ],
    "isLastPage": true,
    "totalPages": 1
}

422 Unable to be processed!

{
    "message": "Error, Please check your entries and try again!"
}

Create a comment

POST http://127.0.0.1:8000/api/comments/create

This endpoint allows you to create a comment

Request Body

Name	Type	Description
commentable_key	string	comment-able key [unique key]
commentable_id	string	comment-able id [unique id]
name	string	comment's author name
email	string	comment's author email
body	string	comment's body
rating	number	comment's rating by default = 0
reply_id	string	reply id = comment's id column (self-relationship)

201 Comment successfully created

{ message: "Created Successfully." }

422 When an error occur

{ message: "Error, Not Created!" }

Update a comment

PUT http://127.0.0.1:8000/api/comments/update

This endpoint allows you to update a comment byid and the <column-name> you want to be updated (single/Multiple).

Query Parameters

Name	Type	Description
<column-name>	string	<column-name> to be updated (Single/Multiple columns). Ex (Single): ?name=Munafio Ex (Multiple): ?name=Munafio&body=hi
id	string	targeted comment's id to be updated. Ex: ?id=xxxxxx

200 When the comment updated successfully.

{ message: "Updated Successfully." }

422 When comment update fails.

{
      message:"An error occured while updating the record! Please check your entries.",
}

Delete a comment

DELETE http://127.0.0.1:8000/api/comments/delete

This endpoint allows you to delete a comment by id

Query Parameters

Name	Type	Description
id	string	targeted comment's id to be deleted.

200 Deleted successfully

{ message: "The record has been deleted!" }

422 Delete fails

{
    message: "An error occured while deleting this record!",
}