Add Pagination to the API
Nobody has claimed this yet.
- Dominant language
- Svelte
- Stars
- 1.2k
- Forks
- 515
- Avg merge
- 23h
- Merged PRs (30d)
- 13
Description
Hi everyone, I think it could be a nice idea to add in the API section an endpoint to retrieve the shows list in paginated format, something like limit and offset in SQL. I propose this change because it would be very useful in case you want to implement a list with the contents that load on a scroll and an endpoint that returns the paginated results would be very useful.
Based on the current API structure, the endpoint could look like this:
https://syntax.fm/api/shows/paginated-[offset]-[limit]
or
https://syntax.fm/api/shows/paginated?offset=[offset]&limit=[limit]
I am developing a Flutter app for a side-project that shows the list of episodes and this feature could be very useful.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the API section serving the shows list and compare the existing endpoint conventions. Confirm the expected offset and limit behavior for the proposed paginated endpoint, then add coverage for paginated show-list responses; done means callers can request predictable slices of the list.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, backend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100