Skip to content

Commit

Permalink
Update API URLs in README.md and code files
Browse files Browse the repository at this point in the history
  • Loading branch information
ewilan-riviere committed Oct 4, 2024
1 parent 5981674 commit 5b05c55
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ Query parameters
> [!WARNING]\
> If crawler is not a browser, response will be original XML feed.
Example: <https://feedrender.kiwilan.app/api/render?url=https://2hdp.fr/2HDP.xml>
Example: <https://feedrender.kiwilan.app/api/render?url=http://zqsd.fr/zqsd.xml>

### JSON

Expand All @@ -105,7 +105,7 @@ Query parameters
| ----- | -------- | -------- | ----------- | --------------------------------- |
| `url` | true | `string` | `undefined` | URL of RSS feed, allow base64 URL |

Example: <https://feedrender.kiwilan.app/api/json?url=https://2hdp.fr/2HDP.xml>
Example: <https://feedrender.kiwilan.app/api/json?url=http://zqsd.fr/zqsd.xml>

### XML

Expand All @@ -126,7 +126,7 @@ Query parameters
| ----- | -------- | -------- | ----------- | --------------------------------- |
| `url` | true | `string` | `undefined` | URL of RSS feed, allow base64 URL |

Example: <https://feedrender.kiwilan.app/api/xml?url=https://feedpress.me/rdvjeux>
Example: <https://feedrender.kiwilan.app/api/xml?url=http://zqsd.fr/zqsd.xml>

## Tests

Expand Down
6 changes: 3 additions & 3 deletions src/routes/api/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,23 @@ export default async () => {
format: '`html` or `json`, optional, default `html`, type of response, default `html` will render HTML page, `json` will give JSON response with HTML string',
},
about: 'Render HTML from RSS feed. If User-Agent is not a browser, it will return XML RSS feed',
example: route('/api/render', { query: { url: 'https://2hdp.fr/2HDP.xml' } }),
example: route('/api/render', { query: { url: 'http://zqsd.fr/zqsd.xml' } }),
},
parser: {
url: route('/api/json'),
query: {
url: '`string`, required, url to RSS feed (could be base64 encoded)',
},
about: 'Parse RSS feed and return JSON',
example: route('/api/json', { query: { url: 'https://2hdp.fr/2HDP.xml' } }),
example: route('/api/json', { query: { url: 'http://zqsd.fr/zqsd.xml' } }),
},
xml: {
url: route('/api/xml'),
query: {
url: '`string`, required, url to RSS feed (could be base64 encoded)',
},
about: 'Parse XML RSS feed and return XML (useful for feeds with HTML render)',
example: route('/api/xml', { query: { url: 'https://feedpress.me/rdvjeux' } }),
example: route('/api/xml', { query: { url: 'http://zqsd.fr/zqsd.xml' } }),
},
},
}
Expand Down
2 changes: 1 addition & 1 deletion tests/feeds.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const feeds = [
'http://www.zqsd.fr/zqsd.xml',
'http://feeds.feedburner.com/LaperoDuCaptain',
'https://feeds.acast.com/public/shows/cabcdc65-9f15-5900-a971-d6d96f16ed31',
'https://2hdp.fr/2HDP.xml',
'http://zqsd.fr/zqsd.xml',
'https://feeds.acast.com/public/shows/b6dda9e2-3ed6-4145-8bcf-3a279a1e1baa',
]

Expand Down

0 comments on commit 5b05c55

Please sign in to comment.