Comments Application

This section describes the API endpoints for managing comments.

Base URL: /

Authentication:

Most API calls require authorization with a valid access token. You can obtain an access token by logging in with a username and password (refer to Accounts section).

Create Comment

• Method: POST
• Endpoint: /comments/create/
• Authorization: Bearer <access_token>
• Request Body:

{
  "content": "string",
  "post_code": "string"  // The unique code of the post to comment on
}

• Response:

{
  "message": "Created comment succesfully."
}

• Description: Create a new comment on a post.

Get Comment by ID

• Method: GET
• Endpoint: /comments/read/<comment_id>/
• Path Variable:
  • <comment_id>: The unique identifier of the comment to retrieve.
• Response:

{
  "comment": {
    "id": integer,
    "content": "string",
    "created": "string (date-time)",
    "updated": "string (date-time)",
    "author": {
      "full_name": "string",
      "username": "string",
      "bio": "null|string",
      "profile_image": "null|string",
      "following_count": integer,
      "follower_count": integer,
      "is_follow": boolean,
      "is_verify": boolean
    },
    "like_count": integer,
    "is_like": boolean
  }
}

• Description: Get information about a specific comment by its unique ID.

Update Comment

• Method: PUT
• Endpoint: /comments/update/<comment_id>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <comment_id>: The unique identifier of the comment to update.
• Request Body:

{
  "content": "string"  // The updated content of the comment
}

• Response:

{
  "updated_comment": {
    "comment": {
      "id": integer,
      "content": "string",
      "created": "string (date-time)",
      "updated": "string (date-time)",
      "author": {
        "full_name": "string",
        "username": "string",
        "bio": "null|string",
        "profile_image": "null|string",
        "following_count": integer,
        "follower_count": integer,
        "is_follow": boolean,
        "is_verify": boolean
      },
      "like_count": integer,
      "is_like": boolean
    }
  }
}

• Description: Update the content of an existing comment.

Delete Comment

• Method: DELETE
• Endpoint: /comments/delete/<comment_id>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <comment_id>: The unique identifier of the comment to delete.
• Response:

{
  "message": "Comment deleted successfully!"
}

• Description: Delete a comment.

Like Comment

• Method: POST
• Endpoint: /comments/like/<comment_id>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <comment_id>: The unique identifier of the comment to like/unlike.
• Response:

{
  "message": "You are now like/unlike <comment_content>." (depending on action)
}

• Description: Like or unlike a comment. Liking a comment increases the comment's like count.

Get Comments for Post

• Method: GET
• Endpoint: /comments/post/<post_code>/
• Path Variable:
  • <post_code>: The unique code of the post to retrieve comments for.
• Response:

{
  "comments": [
    # List of comments for the specified post
  ]
}

• Description: Get a list of comments for a specific post.