Posts Application

This section describes the API endpoints for managing posts.

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).

Retrieve all Posts List (paginated)

• Method: GET
• Endpoints: /posts/
• Parameters:
• page (integer, optional): The page number to retrieve. Defaults to 1.
  For example, /posts/?page=2 retrieves the second page of results.
• size (integer, optional): The number of posts to return per page. Defaults to a value set by the PageNumberPagination class (typically 10).
  For example, /posts/?size=25 returns 25 posts per page.

• Response:

{
  "count": integer,
  "next": "null|string",          # Added for pagination links (if applicable)
  "previous": "null|string",  # Added for pagination links (if applicable)
  "posts": [
    # List of posts
  ]
}

• Description: Retrieves a paginated list of all public posts. You can optionally filter the results using query parameters.

Create Post

• Method: POST
• Endpoints: /posts/create/
• Authorization: Bearer <access_token>
• Request Body:

{
  "title": "string",
  "content": "string"
}

• Response:

{
  "created_post": {
    "code": "string",
    "target": "string",
    "title": "string",
    "content": "string",
    "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
    },
    "created": "string (date-time)",
    "updated": "null|string (date-time)",
    "like_count": integer,
    "is_like": boolean,
    "is_save": boolean,
    "status": "string",
    "views": integer,
    "comment_count": integer
    }
}

• Description: Create a new post.

Update Post

• Method: PUT
• Endpoints: /posts/update/<code>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <code>: The unique code of the post to update.
• Request Body:

{
  "title": "string",
  "content": "string"
}

• Response:

{
  "message": "Post updated successfully"
}

• Description: Update an existing post. Only the provided fields in the request body will be updated.

Delete Post

• Method: DELETE
• Endpoints: /posts/delete/<code>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <code>: The unique code of the post to delete.
• Response:

{
  "message": "Post deleted successfully"
}

• Description: Delete a post.

Save Post

• Method: POST
• Endpoints: /posts/save/<code>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <code>: The unique code of the post to save/unsave.
• Response:

{
  "message": "You are now save/unsave <post_title>." (depending on action)
}

• Description: Save or unsave a post. Saving a post adds it to the current user's saved list.

Like Post

• Method: POST
• Endpoints: /posts/like/<code>/
• Authorization: Bearer <access_token>
• Path Variable:
  • <code>: The unique code of the post to like/unlike.
• Response:

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

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

Get Post by Code

• Method: GET
• Endpoints: /posts/read/<code>/
• Path Variable:
  • <code>: The unique code of the post to retrieve.
• Response:

{
  "post": {
    "code": "string",
    "target": "/post/9Qejlp8IXpe",
    "title": "string",
    "content": "string",
    "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
    },
    "created": "string (date-time)",
    "updated": "null|string (date-time)",
    "like_count": integer,
    "is_like": boolean,
    "is_save": boolean,
    "status": "string",
    "views": integer,
    "comment_count": integer
  }

• Description: Get information about a specific post by its unique code.

Get Liked Posts

• Method: GET
• Endpoints: /posts/liked/
• Authorization: Bearer <access_token>
• Response:

{
  "posts": [
    # List of posts liked by the current user
  ]
}

• Description: Get a list of posts liked by the currently logged-in user.

Get Saved Posts

• Method: GET
• Endpoints: /posts/saved/
• Authorization: Bearer <access_token>
• Response:

{
  "posts": [
    # List of posts saved by the current user
  ]
}

• Description: Get a list of posts saved by the currently logged-in user.