The Articles Collection API empowers you to manage news articles within the Newspaper Backend system. Through these endpoints, you can perform essential CRUD (Create, Read, Update, Delete) operations on articles, ensuring seamless publication and retrieval of news content.
\nBase URL: https://newspaper.azurewebsites.net/api/v1/article
This endpoint allows you to create a new article.
\nHTTP Request
\nPOST {{base_artical}}/create-article\n\nRequest Body
\ntitle (string, required): The title of the article.content (string, required): The content of the article.category (string, required): The category of the article.Example Request
\n{\n \"title\": \"Sample Title\",\n \"content\": \"Sample Content\",\n \"category\": \"Sample Category\"\n}\n\nResponse
\nstatusCode (number): The status code of the response.data (string): The data of the response.message (object): The message object containing details of the created article.title (string): The title of the created article.content (string): The content of the created article.author (string): The author of the created article.category (string): The category of the created article._id (string): The unique identifier of the created article.publicationDate (string): The publication date of the created article.__v (number): Version control of the created article.success (boolean): Indicates if the request was successful.Example Response
\n{\n \"statusCode\": 0,\n \"data\": \"\",\n \"message\": {\n \"title\": \"Sample Title\",\n \"content\": \"Sample Content\",\n \"author\": \"\",\n \"category\": \"Sample Category\",\n \"_id\": \"sample_id\",\n \"publicationDate\": \"2022-01-01\",\n \"__v\": 0\n },\n \"success\": true\n}\n\nError: Category does not exist || Please create one\n\n \n"}],"_postman_id":"18258d1d-9e50-4761-8595-31affe75c8e6"},{"name":"All Articles","id":"96ac6879-8201-486e-a82c-d4f507286c04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_artical}}?page=1&pageSize=1","description":"
at /home/site/wwwroot/controllers/articleController.js.js:24:11\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
This endpoint makes an HTTP GET request to retrieve a single page of articles with a specified page number and page size. The response will include an array of articles, along with metadata such as total pages, current page, page size, and total number of articles.
\nThe response will have a status code of 200 and a content type of application/json. The response body will contain a statusCode, data array with article details, totalPages, currentPage, pageSize, totalArticles, message, and success indicators.
\nHere is an example of the response:
\n{\n \"statusCode\": 0,\n \"data\": [\n {\n \"_id\": \"\",\n \"title\": \"\",\n \"content\": \"\",\n \"author\": {\n \"_id\": \"\"\n },\n \"category\": {\n \"_id\": \"\",\n \"name\": \"\"\n },\n \"publicationDate\": \"\",\n \"__v\": 0\n }\n ],\n \"message\": \"\",\n \"success\": true\n}\n\nThis endpoint makes an HTTP GET request to retrieve an article with a specific ID. The response will include the status code, data, message, and success indicator. The data will contain details of the article such as ID, title, content, author, category, and publication date.
\n","urlObject":{"path":["65f062a6b8fcddab17620f39"],"host":["{{base_artical}}"],"query":[],"variable":[]}},"response":[{"id":"472193ed-35fa-46a0-a93b-acfd36354d84","name":"200 Success","originalRequest":{"method":"GET","header":[],"url":"{{base_artical}}/65f062a6b8fcddab17620f39"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"496"},{"key":"ETag","value":"W/\"1f0-EmyfzeJBcfHwBsqAzgBFuDWEpv8\""},{"key":"Date","value":"Tue, 12 Mar 2024 14:21:56 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"statusCode\": 200,\n \"data\": \"article found\",\n \"message\": {\n \"_id\": \"65f062a6b8fcddab17620f39\",\n \"title\": \"Practical Frozen Towels\",\n \"content\": \"Optio assumenda ducimus aspernatur odit quibusdam explicabo sed officiis. Necessitatibus omnis ut rem recusandae molestiae. Ab voluptatem nemo nihil non dolor minus ea sed explicabo.\",\n \"author\": {\n \"_id\": \"65ee2e7045f5634805992ae8\"\n },\n \"category\": {\n \"_id\": \"65ef61230c5505a51aaae0f1\",\n \"name\": \"uncategorized\"\n },\n \"publicationDate\": \"2024-03-12T14:11:50.474Z\",\n \"__v\": 0\n },\n \"success\": true\n}"},{"id":"8dd05340-f11b-4fcc-99a6-40396fa6b991","name":"400 Bad Request","originalRequest":{"method":"GET","header":[],"url":"{{base_artical}}/65f062a6b8fcddab17620"},"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":"1339"},{"key":"Date","value":"Tue, 12 Mar 2024 14:20:58 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"\n\n \n \nError: Article Id must be 24 characters in legnth\n\n \n"}],"_postman_id":"8a7b6001-28a4-4f68-ab91-fcbf02ff2d70"},{"name":"Delete Article","id":"d5e5bdfa-12b1-4878-9d7f-5982395cdf5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"{{base_artical}}/65f062a6b8fcddab17620f39","description":"
at F:\\Personal Project\\Newspaper-Backend\\controllers\\articleController.js.js:83: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 Route.dispatch (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\route.js:112:3)\n
at Layer.handle [as handle_request] (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\layer.js:95:5)\n
at F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\index.js:281:22\n
at param (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\index.js:354:14)\n
at param (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\index.js:365:14)\n
at Function.process_params (F:\\Personal Project\\Newspaper-Backend\\node_modules\\express\\lib\\router\\index.js:410:3)\n
This endpoint is used to delete a specific article by its ID.
\n{{base_artical}}/65f062a6b8fcddab17620f39statusCode (number): The status code of the response.data (string): The data returned in the response.message (object): An object containing details of the deleted article, including its ID, title, content, author, category, and publication date.success (boolean): Indicates whether the deletion was successful.Error: Article Id must be 24 characters in legnth\n\n \n"}],"_postman_id":"d5e5bdfa-12b1-4878-9d7f-5982395cdf5a"},{"name":"Update Article","id":"8c58a4f9-7dec-404e-9fce-83328a3d0c6d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n {\r\n \"title\": \"Refined Fresh Cheese\",\r\n \"content\": \"Vel ut placeat sint. Enim ut aut labore repudiandae veniam beatae aut quo quae. Dolorem accusantium libero neque aut quia. Aliquam dolorum harum laboriosam. Accusamus magnam quam aliquid delectus.\",\r\n \"category\": \"uncategorized-new\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_artical}}/65f0630db8fcddab17620f41","description":"
at F:\\Personal Project\\Newspaper-Backend\\controllers\\articleController.js.js:125: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:31:5)\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
This endpoint allows the user to update an article with the specified ID. The HTTP PUT request should be made to {{base_artical}}/65f0630db8fcddab17620f41, with the following payload in the raw request body type:
\n{\n \"title\": \"\",\n \"content\": \"\",\n \"category\": \"\"\n}\n\nstatusCode (number): Indicates the status of the response.data (string): Represents the data returned in the response.message (object): Contains details about the updated article, including its ID, title, content, author, category, and publication date.success (boolean): Indicates whether the update was successful.Example Response:
\n{\n \"statusCode\": 0,\n \"data\": \"\",\n \"message\": {\n \"_id\": \"\",\n \"title\": \"\",\n \"content\": \"\",\n \"author\": \"\",\n \"category\": \"\",\n \"publicationDate\": \"\",\n \"__v\": 0\n },\n \"success\": true\n}\n\nError: Article Id must be 24 characters in legnth\n\n \n"},{"id":"ab52e516-14c1-4e3d-b3be-41eb15b1d262","name":"400 Field error","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n {\r\n \r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_artical}}/65f0630db8fcddab17620f"},"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":"827"},{"key":"Date","value":"Tue, 12 Mar 2024 15:21:18 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\\articleController.js.js:116: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:31:5)\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
Error: Minimum of one field is required to update article\n\n \n"},{"id":"8c338003-c545-4f50-bd7c-b1146bfa60cd","name":"404 Category Not found","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"\r\n {\r\n \"title\": \"Incredible Granite Bacon\",\r\n \"content\": \"Dolorum qui illo omnis. Fugit et quia nihil vitae odio. Neque voluptatem quo aut quia laudantium quis.\",\r\n \"category\": \"uncategorized-newss\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{base_artical}}/65f0630db8fcddab17620f41"},"status":"Not Found","code":404,"_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":"374"},{"key":"Date","value":"Tue, 12 Mar 2024 15:22:22 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\\articleController.js.js:104: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:31:5)\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
Error: Category does not exist || Please create one\n\n \n"}],"_postman_id":"8c58a4f9-7dec-404e-9fce-83328a3d0c6d"},{"name":"Get Articles By Category","id":"542698fc-2e91-4047-b4a2-9c5861fa9722","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{base_artical}}/category/uncategorized-new","description":"
at F:\\Personal Project\\Newspaper-Backend\\controllers\\articleController.js.js:124:11\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n
This endpoint makes an HTTP GET request to retrieve the articles under the 'uncategorized' category.
\nIn case of a successful request, the response will include an array of articles with details such as title, content, author, category, and publication date.
\nIn case of an error, the response will have a status code of 404 with a content type of text/html. The body of the response will include an error message indicating that the category was not found.
\n{\"statusCode\":0,\"data\":[{\"_id\":\"\",\"title\":\"\",\"content\":\"\",\"author\":\"\",\"category\":\"\",\"publicationDate\":\"\",\"__v\":0}],\"message\":\"\",\"success\":true}\n\nError: Category not found\n\n \n"}],"_postman_id":"542698fc-2e91-4047-b4a2-9c5861fa9722"}]}
at F:\\Personal Project\\Newspaper-Backend\\controllers\\articleController.js.js:204:11\n
at process.processTicksAndRejections (node:internal/process/task_queues:95:5)\n