yuzurss

Feed aggregator microservice based on Spring
git clone https://git.neuralcrash.com/yuzurss.git
Log | Files | Refs | README | LICENSE

README.md (2108B)


      1 # YuzuRSS
      2 Feed aggregator microservice based on Spring
      3 
      4 ## Usage
      5 
      6 Just send a POST request, with in the body of the request a JSON object with the below:
      7 
      8 | Parameter  | Description                                                                                                                                 |
      9 | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
     10 | limit      | Number of feed entries to be provided                                                                                                       |
     11 | urls       | List of RSS/Atom/RDF feed URLs to aggregate                                                                                                 |
     12 | dateBefore | Filter the entries to only keep the ones with a publication date before or equals to this argument. Format is "yyyy-MM-dd", timezone is UTC |
     13 | dateAfter  | Filter the entries to only keep the ones with a publication date after or equals to this argument. Format is "yyyy-MM-dd", timezone is UTC  |
     14 
     15 Example:
     16 
     17 	POST https://yuzurss.kebigon.xyz
     18 
     19 	{
     20 		"limit": 2,
     21 		"urls": [
     22 			"https://www.youtube.com/feeds/videos.xml?user=epenser1",
     23 			"https://www.youtube.com/feeds/videos.xml?user=scilabus",
     24 			"https://www.youtube.com/feeds/videos.xml?user=TroncheEnBiais"
     25 		],
     26 		"dateAfter": "2020-01-22"
     27 	}
     28 
     29 The response will be a [JSON Feed](https://jsonfeed.org/version/1):
     30 
     31 Example:
     32 
     33 	{
     34 		"version": "https://jsonfeed.org/version/1",
     35 		"title": "YuzuRSS aggregated feed",
     36 		"items": [
     37 			{
     38 				"id": "yt:video:C9bLMf6Q-qk",
     39 				"url": "https://invidio.us/watch?v=C9bLMf6Q-qk",
     40 				"title": "Pour en finir avec l'homéopathie - Tronche de Fake 4.8",
     41 				"author": {
     42 					"name": "La Tronche en Biais"
     43 				},
     44 				"date_published": "2020-01-23T10:43:08.000Z"
     45 			},
     46 			{
     47 				"id": "yt:video:hJe5MDMWOaU",
     48 				"url": "https://invidio.us/watch?v=hJe5MDMWOaU",
     49 				"title": "Les trous noirs (1/2) - 48 - e-penser",
     50 				"author": {
     51 					"name": "e-penser"
     52 				},
     53 				"date_published": "2020-01-23T08:09:43.000Z"
     54 			}
     55 		]
     56 	}