Introduction
Stack2RSS is a simple web application that creates an RSS feed given an API route.
Usage
Using Stack2RSS is relatively simple. The general format of the URL for a feed looks something like this:
/ {Stack Exchange Site Domain} / {API route} ? {Parameters}
There are a couple things to note here:
- The domain is of the form
site.com
(examples: stackoverflow.com
, apple.stackexchange.com
, stackauth.com
).
- You do not need to specify an API key as Stack2RSS will use its own key.
- You can use v1.0 methods by passing the 'api_version=1.0' query string parameter.
Summary of the Process
- Fetch and process all parameters
- Make API request to given method
- Convert results returned to HTML
- Create RSS-compliant feed from items
- Echo it to the client
Code Structure
The code is basically divided into two sections:
- the Stack2RSS class that is actually responsible for the requests / parameter parsing / etc.
- a bunch of classes that derive from BaseConverter which convert one particular type of item (such as 'user' or 'question') into an HTML representation
Important Classes
Conversion Classes