An open standard for self-hosted RSS aggregator APIs.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Shadowfacts 8100818e26
Add Group service_url
3 years ago
.gitignore Initial commit 3 years ago
README.md Initial commit 3 years ago
authentication.md Add no redirect for authentication 3 years ago
endpoints.md Additional management endpoints 3 years ago
entities.md Add Group service_url 3 years ago
extensions.md Additional management endpoints 3 years ago
pagination.md Initial commit 3 years ago

README.md

Fervor API

Fervor is a open standard for a self-hosted RSS aggregator API. It's primary goal is to replace the current de-facto standard, the Fever API.

The Fever API has a number of issues, including:

  1. Using MD5 for authentication.
  2. Poor design (e.g. group and feeds_group being separate entities.)
  3. Poor documentation (the difference between group and feeds_group is never articulated.)
  4. No longer being maintained.

The Fervor API is intended to be a common foundation for self-hosted RSS aggregators, not a catch-all solution. Different services will have their own specific needs from an API, so Fervor is designed to be only the component that is common to all of RSS aggregator implementations.

Specification

The specification is divided into the following sections:

Versioning

The Fervor API uses Semantic Versioning.

Minor fixes increment the patch number, minor additions increment the minor number, and any removals increment the major number.

The current Fervor version is 0.1.0. The major version 0 will remain until the specification is finished and no longer a draft.

Known Implementations

Clients

Servers