{"info":{"_postman_id":"5848039e-2bd6-4670-bc86-d437a7c0ef5e","name":"NewsAgregator","description":"

This project is a Laravel application designed to fetch articles from multiple sources using their respective APIs. The articles are stored in a local database. Stored articles support searching, filtering, and respecting user preferences.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"8772623","collectionId":"5848039e-2bd6-4670-bc86-d437a7c0ef5e","publishedId":"2sAYJ4hzpw","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-12-23T23:49:18.000Z"},"item":[{"name":"SearchArticles","id":"411560c3-d881-4374-9617-e33d51778dce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:8000/api/v1/articles?search=&limit=20&page=1","description":"

GET /api/v1/articles

GET /api/v1/articles?search=&category=&source=&author=&from_date=&to_date=&limit=20&page=1

The endpoint retrieves a list of articles based on the specified search criteria such as category, source, author, date range, limit, and page number.

Sample API Response When fetching articles, the API returns a structured JSON response:

{\n    \"result\": true,\n    \"status\": \"success\",\n    \"message\": \"Articles fetched\",\n    \"data\": {\n        \"articles\": [\n            {\n                \"id\": 1,\n                \"title\": \"Sample Article\",\n                \"author\": \"Author 1\",\n                \"description\": \"This is a description of the sample article.\",\n                \"url\": \"https://example.com/sample-article\",\n                \"category\": \"Technology\",\n                \"source\": \"Source 1\",\n                \"published_at\": \"2024-12-21T23:40:56+0000\",\n                \"created_at\": \"2024-12-21T23:40:56+0000\",\n                \"updated_at\": \"2024-12-21T23:40:56+0000\"\n            }\n        ],\n        \"meta\": {\n            \"current_page\": 1,\n            \"last_page\": 10,\n            \"per_page\": 10,\n            \"total\": 100\n        }\n    }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8000","path":["api","v1","articles"],"host":["localhost"],"query":[{"description":{"content":"

string

\n","type":"text/plain"},"key":"search","value":""},{"disabled":true,"description":{"content":"

string (Foreign | Sports | Technology)

\n","type":"text/plain"},"key":"category","value":"Sports"},{"disabled":true,"description":{"content":"

News API | New York Times | Guardian

\n","type":"text/plain"},"key":"source","value":"New York Times"},{"disabled":true,"description":{"content":"

string

\n","type":"text/plain"},"key":"author","value":""},{"disabled":true,"description":{"content":"

date | Y-m-d

\n","type":"text/plain"},"key":"from_date","value":"2024-12-21"},{"disabled":true,"description":{"content":"

date | Y-m-d

\n","type":"text/plain"},"key":"to_date","value":"2024-12-25"},{"description":{"content":"

integer

\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"

integer

\n","type":"text/plain"},"key":"page","value":"1"}],"variable":[]}},"response":[],"_postman_id":"411560c3-d881-4374-9617-e33d51778dce"},{"name":"ShowArticles","id":"a081050f-7235-4695-8028-1cd85885e3e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"url":"http://localhost:8000/api/v1/article/400","description":"

GET /api/v1/article/{id}

This endpoint retrieves the details of a specific article identified by the provided ID.

Request

No request body is required for this endpoint.

id (path parameter) - The unique identifier of the article.

Sample Response

{\n    \"result\": true,\n    \"status\": \"success\",\n    \"message\": \"Article fetched\",\n    \"data\": {\n        \"articles\": {\n            \"id\": 1,\n            \"title\": \"Sample Article\",\n            \"author\": \"Author 1\",\n            \"description\": \"This is a description of the sample article.\",\n            \"url\": \"https://example.com/sample-article\",\n            \"category\": \"Technology\",\n            \"source\": \"Source 1\",\n            \"published_at\": \"2024-12-21T23:40:56+0000\",\n            \"created_at\": \"2024-12-21T23:40:56+0000\",\n            \"updated_at\": \"2024-12-21T23:40:56+0000\"\n        }\n    }\n}\n\n

\n","urlObject":{"protocol":"http","port":"8000","path":["api","v1","article","400"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"a081050f-7235-4695-8028-1cd85885e3e5"},{"name":"Register","id":"bb78dc19-6d42-4e31-9611-3de770daec50","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"name","value":"Joe nema","type":"text"},{"key":"email","value":"code@appwiz.dev","type":"text"},{"key":"password","value":"Hezecom@24","type":"text"}]},"url":"http://localhost:8000/api/v1/auth/register","urlObject":{"protocol":"http","port":"8000","path":["api","v1","auth","register"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"bb78dc19-6d42-4e31-9611-3de770daec50"},{"name":"Login","id":"c01a09f8-0703-4943-8ec9-dfef1ec963cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"code@appwiz.dev","type":"text"},{"key":"password","value":"Hezecom@24","type":"text"}]},"url":"http://localhost:8000/api/v1/auth/login","urlObject":{"protocol":"http","port":"8000","path":["api","v1","auth","login"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"c01a09f8-0703-4943-8ec9-dfef1ec963cc"},{"name":"User","id":"2ae45ddc-0d66-4028-adb7-94991eb8beb6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"email","value":"code@appwiz.dev","type":"text"},{"key":"password","value":"Hezecom@24","type":"text"}]},"url":"http://localhost:8000/api/v1/auth/user","urlObject":{"protocol":"http","port":"8000","path":["api","v1","auth","user"],"host":["localhost"],"query":[],"variable":[]}},"response":[],"_postman_id":"2ae45ddc-0d66-4028-adb7-94991eb8beb6"}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"4b45ca81-b828-4476-9e47-0ee319edbd63"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"1536c429-8cf7-40fb-b9b2-49de66651843"}}],"variable":[{"key":"id","value":"1"},{"key":"base_url","value":"https://postman-rest-api-learner.glitch.me/"}]}