RSS API project

A REST API in typescript for creating and updating your online content using an RSS feed.

Requirements

Nodejs, Typescript and Yarn.

Structure

• In src folder, there are:
  • index.ts including the instantiation of express app.
  • the router folder including the api.ts with the configuration of the routes.
  • the controller folder including functionality used inside routes, regarding creating and updating feed.
• config folder includes a file with the default parameters that can be accessed throughout the repository.
• In package.json, you can find project related information, such as name and dependencies.
• Folder lib does not exist but will be created. It will include the transpiled javascript files coming from the corresponding typescript files.

How to run the server

In order to install all packages, you have to use:

yarn

And for transpiling to javascript, you have to run:

yarn build

Then, in order to run the server, you have to use:

yarn server

The API runs on: http://localhost:8080/ .

Work with data

For updating your RSS, you have to do a post request with content type header application/json and as data a JSON with the string properties title, link and description.

You get back the RSS everytime you update but also with a simple get request.