This collection of APIs facilitates various operations related to blog management, including creating, updating, deleting, and retrieving blog posts. Additionally, it provides functionalities for publishing/unpublishing posts, searching for posts by tags, and fetching posts for the home page. The collection ensures user authentication and authorization for sensitive actions like creating, updating, and deleting posts.
\nEndpoints in this collection:
\nCreate New Blog Post: Allows users to create a new blog post with essential details such as title, content, tags, and image.
\nUnpublish Blog Post: Enables users to unpublish a specific blog post.
\nPublish Blog Post: Allows users to publish a previously unpublished blog post.
\nGet Home Page Blog Posts: Retrieves blog posts for display on the home page, considering factors like popularity and relevance.
\nSearch Posts with Tag: Searches for blog posts containing a specific tag.
\nGet Specific Post: Fetches details of a specific blog post based on its ID.
\nUpdate Post: Allows users to update an existing blog post, including modifying content, title, tags, and image.
\nDelete Post: Deletes a specific blog post.
\nGet All Posts by Skip and Limit: Retrieves all published blog posts with pagination support, allowing users to specify the number of posts to skip and the maximum number of posts to return per request.
\nThese APIs collectively provide comprehensive functionality for managing blog content efficiently, catering to both content creators and consumers.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"31843425","collectionId":"30444366-1ac9-481d-98b4-a71f7ca47853","publishedId":"2sA2xk1BXv","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-03-13T12:53:53.000Z"},"item":[{"name":"Creating New Blog Post","id":"ba6bfee0-fd47-4d69-9c34-1da118a04ec8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"title","value":"Demystifying Data Structures: A Beginner's Guide","type":"text","id":0},{"key":"content","value":"Data structures form the foundation of computer science","type":"text","id":1},{"key":"tags","value":"[\"git\",\"main\",\"token\"]","type":"text","id":2},{"key":"seoKeywords","value":"[\"Data Structures\", \"Computer Science\", \"Algorithms\", \"Arrays\", \"Linked Lists\", \"Stacks\", \"Queues\"]","type":"text","id":3},{"key":"metaDescription","value":"Uncover the fundamentals of data structures in this beginner-friendly guide. ","type":"text","id":4},{"key":"postImage","type":"file","id":5,"fileUploadError":"","src":["C:\\Users\\Shubham Gupta\\Downloads\\dsa.jpg"]},{"key":"authorId","value":"65eef6745e3bb295cfe56319","type":"text","id":6},{"key":"url","value":"data-structure-and-algorithm","type":"text","id":7}]},"url":"{{server}}/blogs/create","description":"Endpoint: POST /api/v1/blogs/create
Description: This endpoint allows users to create a new blog post.
Request Body:
title: The title of the blog post.
\ncontent: The content or body of the blog post.
\ntags: An array of tags associated with the blog post.
\nseoKeywords: Keywords for SEO optimization.
\nmetaDescription: A brief description for meta tags.
\npostImage: An image file representing the blog post.
\nauthorId: The ID of the author creating the blog post.
\nResponse:
\n200 OK: Blog post creation successful. Returns the newly created blog post object.
\n400 Bad Request: If any of the required fields are missing or invalid.
\n403 Forbidden: If the user is not authorized to create the blog post.
\n404 Not Found: If the specified author ID is not found.
\nNotes:
\nThe postImage will be uploaded and associated with the blog post.
\nAccess control is enforced based on the author's ID.
\nRate limiting is applied to prevent abuse or spam.
\nEndpoint: PATCH /api/v1/blogs/:id
Description: This endpoint allows users to unpublish a blog post.
Request Body:
Response:
\n200 OK: Blog post unpublished successfully.
\n401 Unauthorized: If the user is not authorized to unpublish the post.
\n404 Not Found: If the specified blog post ID is not found.
\nNotes:
\nAccess control is enforced based on the user's authorization.
\nOnly the author of the blog post or an admin can unpublish a post.
\nEndpoint: PATCH /api/v1/blogs/publish/:id
Description: This endpoint allows users to publish a blog post.
Request Body:
Response:
\n200 OK: Blog post published successfully.
\n401 Unauthorized: If the user is not authorized to publish the post.
\n404 Not Found: If the specified blog post ID is not found.
\nNotes:
\nAccess control is enforced based on the user's authorization.
\nOnly the author of the blog post or an admin can publish a post.
\nEndpoint: GET /api/v1/blogs/
Description: This endpoint retrieves the home page blog posts.
Request Body:
Response:
\nNotes:
\nEndpoint: POST /api/v1/blogs/tag
Description: This endpoint allows users to search for blog posts by tag.
Request Body:
Response:
\n200 OK: Blog posts fetched successfully. Returns an array of posts matching the provided tag.
\n400 Bad Request: If the tagsearch parameter is missing or invalid.
\n404 Not Found: If no blog posts are found matching the provided tag.
\nNotes:
\nAccess control is not required for this endpoint as it's publicly accessible.
\nThe tagsearch parameter is used to search for blog posts with matching tags.
\nEndpoint: GET /api/v1/blogs/:id
Description: This endpoint retrieves a specific blog post by its ID.
Request Parameters:
Response:
\n200 OK: Specific blog post fetched successfully. Returns details of the specified blog post along with its comments.
\n400 Bad Request: If the provided blog post ID is invalid.
\n404 Not Found: If the specified blog post ID is not found.
\nNotes:
\nAccess control is not required for this endpoint as it's publicly accessible.
\nThe response includes details of the blog post along with its comments.
\nEndpoint: PUT /api/v1/blogs/:id
Description: This endpoint allows users to update a specific blog post.
Request Parameters:
Request Body:
\ntitle: The updated title of the blog post.
\npostImage: The updated image for the blog post.
\ncontent: The updated content of the blog post.
\nseoKeywords: The updated SEO keywords for the blog post.
\nmetaDescription: The updated meta description for the blog post.
\ntags: The updated tags for the blog post in JSON format.
\nauthorId: The ID of the author updating the blog post.
\nResponse:
\n200 OK: Blog post updated successfully. Returns details of the updated blog post.
\n400 Bad Request: If any required fields for updating the blog post are missing or invalid.
\n403 Forbidden: If the user attempting to update the blog post is not authorized.
\n404 Not Found: If the specified blog post ID is not found.
\nNotes:
\nAccess control is applied to ensure only authorized users can update blog posts.
\nThe response includes details of the updated blog post.
\nAuthorId and Id is mandatory and also one of the other updating term
\nEndpoint: DELETE /api/v1/blogs/:id
Description: This endpoint allows users to delete a specific blog post.
Request Parameters:
Request Body:
\nResponse:
\n200 OK: Blog post deleted successfully.
\n403 Forbidden: If the user attempting to delete the blog post is not authorized.
\n404 Not Found: If the specified blog post ID is not found.
\nNotes:
\nAccess control is applied to ensure only authorized users can delete blog posts.
\nUpon successful deletion, related comments, likes, and resource files associated with the blog post are also deleted.
\nThe response includes a success message indicating that the blog post was deleted successfully.
\nEndpoint: GET /api/v1/blogs/posts
Description: This endpoint retrieves all published blog posts with pagination support.
Query Parameters:
skip: The number of blog posts to skip.
\nlimit: The maximum number of blog posts to return per request (default limit is 10 if not provided).
\nResponse:
\n200 OK: All posts fetched successfully. Returns an array of blog posts with details.
\n500 Internal Server Error: If an error occurs while fetching the posts.
\nNotes:
\nPagination allows users to retrieve a subset of blog posts at a time.
\nThe response includes information about whether there are more posts available after the current set.
\n