The Categories Collection API provides endpoints for managing article categories within the Newspaper Backend system. Use these endpoints to perform CRUD (Create, Read, Update, Delete) operations on categories, allowing for efficient organization and classification of articles.
\nBase URL: https://newspaper.azurewebsites.net/api/v1/category
This endpoint allows you to create a new category. The request should be sent to {{base_category}}/create-category using the HTTP POST method.
\nThe request body should be in raw JSON format and include the following parameters:
\nname: (string) The name of the category.description: (string) A description of the category.The response will include the following fields:
\nstatusCode: A status code indicating the result of the operation.data: An empty string in this case.message: An object containing the details of the created category, including its name, description, articles, ID, and version.success: A boolean value indicating the success of the operation.Example Response:
\n{\n \"statusCode\": 0,\n \"data\": \"\",\n \"message\": {\n \"name\": \"\",\n \"description\": \"\",\n \"articles\": [],\n \"_id\": \"\",\n \"__v\": 0\n },\n \"success\": true\n}\n\nError: Category already exists\n\n \n"}],"_postman_id":"f1e68119-9a42-4976-ae62-b275ca95ef39"},{"name":"All Categorys","id":"b722be11-1bea-40b3-88c1-9d4f6282d64b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_category}}/","description":"
at F:\\Personal Project\\Newspaper-Backend\\controllers\\categoryController.js:16:11\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
This endpoint makes an HTTP GET request to retrieve the list of categories. The response will be in JSON format with a status code of 200. The response body will contain an array of category objects, where each object includes the category ID, name, description, and a list of articles associated with that category.
\n","urlObject":{"path":[""],"host":["{{base_category}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b722be11-1bea-40b3-88c1-9d4f6282d64b"},{"name":"Get Category","id":"02c6ac34-8334-4baa-ab06-28e36adaf92e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_category}}/65ef015149b11889a23008a1","description":"This endpoint makes an HTTP GET request to retrieve data from the specified category with the given ID. The response will be in JSON format and will include a status code, data, message, and success indicator.
\n","urlObject":{"path":["65ef015149b11889a23008a1"],"host":["{{base_category}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"02c6ac34-8334-4baa-ab06-28e36adaf92e"},{"name":"Update Category","id":"feeb4a2c-bd5c-46bd-902f-1b824d969142","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"uncategorized-updated\",\r\n \"description\": \"Sapiente rerum quaerat. Ducimus saepe illum explicabo et tempora tenetur atque aut. Dolor ducimus sit facere corporis repellendus quae.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_category}}/65ef015149b11889a23008a1","description":"This endpoint makes an HTTP PUT request to update a specific category using the provided category ID in the URL. The request body should contain the updated \"name\" and \"description\" of the category.
\nThe endpoint returns a 404 status code with a \"text/html\" content type in case the category is not found or if there is a database error. The response body contains an error message indicating the cause of the error.
\n{\n \"statusCode\": 0,\n \"data\": \"\",\n \"message\": {\n \"_id\": \"\",\n \"name\": \"\",\n \"description\": \"\",\n \"articles\": [],\n \"__v\": 0\n },\n \"success\": true\n}\n\nError: Category Not Found OR Database Error\n\n \n"},{"id":"e72cca25-c47a-4794-81fd-3aff77f46669","name":"400 Bad Request","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\": \"uncategorized-updated\",\r\n \"description\": \"Cum id hic quia id qui ab. Iste dignissimos cupiditate suscipit dolorem. Vel voluptatem et et eveniet et. Vel repellendus voluptatibus. Fugiat et autem aspernatur. Quasi consequatur nam quas molestiae.\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{base_category}}/65ef015149b11889a2300"},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"807"},{"key":"Date","value":"Mon, 11 Mar 2024 13:26:58 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n
at F:\\Personal Project\\Newspaper-Backend\\controllers\\categoryController.js:60:11\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
Error: Category ID must be 24 characters\n\n \n"}],"_postman_id":"feeb4a2c-bd5c-46bd-902f-1b824d969142"},{"name":"Delete Category","id":"7fe95993-4437-4a4d-bed2-08af55403a50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base_category}}/65ef015149b11889a23008a1","description":"
at F:\\Personal Project\\Newspaper-Backend\\controllers\\categoryController.js:57:11\n
at F:\\Personal Project\\Newspaper-Backend\\utils\\asyncHandler.js:3:21\n
at Layer.handle [as handle_request] (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\layer.js:95:5)\n
at next (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\route.js:137:13)\n
at isUserLoggedin (F:\\Personal Project\\Newspaper-Backend\\middlewares\\isUserLoggedin.js:33:5)\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
This endpoint sends an HTTP DELETE request to the specified category with the given ID. Upon successful deletion, it returns a response with a status code, data, message, and success indicator.
\nThe response will include the following fields:
\nError: Category not found OR DB error\n\n \n"},{"id":"d5842958-6985-463c-a5b7-c3b2c88899bd","name":"400 Bad Request","originalRequest":{"method":"DELETE","header":[],"url":"{{base_category}}/65ef015149b11889a2300"},"status":"Bad Request","code":400,"_postman_previewlanguage":"html","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Security-Policy","value":"default-src 'self'"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Type","value":"text/html; charset=utf-8"},{"key":"Content-Length","value":"807"},{"key":"Date","value":"Mon, 11 Mar 2024 13:23:35 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"\n\n \n \n
at F:\\Personal Project\\Newspaper-Backend\\controllers\\categoryController.js:77:11\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
Error: Category ID must be 24 characters\n\n \n"}],"_postman_id":"7fe95993-4437-4a4d-bed2-08af55403a50"}]}
at F:\\Personal Project\\Newspaper-Backend\\controllers\\categoryController.js:70:11\n
at F:\\Personal Project\\Newspaper-Backend\\utils\\asyncHandler.js:3:21\n
at Layer.handle [as handle_request] (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\layer.js:95:5)\n
at next (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\route.js:137:13)\n
at isUserLoggedin (F:\\Personal Project\\Newspaper-Backend\\middlewares\\isUserLoggedin.js:33:5)\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n