RSS Feed Aggregator

The RSS Feed Aggregator API is a high-performance service built using Go, using sqlc for type-safe SQL queries and goose for database migrations. This API allows you to manage RSS feeds and articles.

How to Run

This API can be run on your local development system using two methods.

Directly

if you have golang and postgresql installed

• set your env

PORT=<port>
DBCONN=postgres://<username>:<password>@<hostname>:5432/<dbname>?sslmode=disable

• install goose
• cd sql/schema
• goose postgres "postgres://<username>:<password>@<hostname>:5432/<dbname>?sslmode=disable" up
• make run

Using Docker

to run the project,

• docker-compose up -d
• docker-compose down to turn down the project

Endpoints

Endpoint	Method	Status	Request	Response
`/users`	POST	201	{ "name": "udin" }	{ "id": "b8239f5e-0227-43d8-b60c-5a184ea80e95", "createdAt": "2024-06-07T19:05:09.815201Z", "updatedAt": "2024-06-07T19:05:09.815201Z", "name": "udin", "apiKey": "<API KEY>" }
`/users`	GET	200	Request Header, 'Authorization': ApiKey <API KEY>	{ "id": "b8239f5e-0227-43d8-b60c-5a184ea80e95", "createdAt": "2024-06-07T19:05:09.815201Z", "updatedAt": "2024-06-07T19:05:09.815201Z", "name": "udin", "apiKey": "<API KEY>" }
`/feeds`	POST	201	Request Header, 'Authorization': ApiKey <API KEY> { "name": "The Verge Tech", "url": "http://www.theverge.com/tech/rss/index.xml" }	{ "feed": { "id": "b87fc085-431a-4606-92f6-bd12f8fd741c", "createdAt": "2024-06-14T08:04:42.546561Z", "updatedAt": "2024-06-14T08:04:42.546561Z", "name": "The Verge Tech", "url": "http://www.theverge.com/tech/rss/index.xml", "userId": "082536ec-3598-4f6d-93d4-0fe23cfc623d" }, "feed_follow": { "id": "5d146edf-7715-42f5-a324-94b2771e3e2a", "feedId": "b87fc085-431a-4606-92f6-bd12f8fd741c", "userId": "082536ec-3598-4f6d-93d4-0fe23cfc623d", "createdAt": "2024-06-14T08:04:42.547676Z", "updatedAt": "2024-06-14T08:04:42.547676Z" } }
`/feeds`	GET	200	Request Header, 'Authorization': ApiKey <API KEY>	[ { "id": "ad1416d3-89ec-48c9-b0eb-5621f8d4ba5c", "createdAt": "2024-06-14T07:49:22.232084Z", "updatedAt": "2024-06-14T07:53:05.541544Z", "name": "CNN Tech", "url": "http://www.buzzfeed.com/tvandmovies.xml", "userId": "082536ec-3598-4f6d-93d4-0fe23cfc623d" }, { "id": "e0a2b609-ab42-460b-8f08-4fb44887790c", "createdAt": "2024-06-10T06:57:58.735041Z", "updatedAt": "2024-06-14T07:53:05.545006Z", "name": "CNN Tech", "url": "http://rss.cnn.com/rss/cnn_tech.rss", "userId": "082536ec-3598-4f6d-93d4-0fe23cfc623d" }, ... ]