https://github.com/willianantunes/drf-like-paginations
Tired of creating pagination all the time in your .NET projects? Apply either Offset or Cursor pagination and focus on business logic 🙂
https://github.com/willianantunes/drf-like-paginations
containerization cursor-pagination dotnet-core entity-framework pagination sonarcloud xunit
Last synced: 11 months ago
JSON representation
Tired of creating pagination all the time in your .NET projects? Apply either Offset or Cursor pagination and focus on business logic 🙂
- Host: GitHub
- URL: https://github.com/willianantunes/drf-like-paginations
- Owner: willianantunes
- License: gpl-3.0
- Created: 2021-06-07T19:14:26.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-06-28T20:46:08.000Z (almost 5 years ago)
- Last Synced: 2024-11-08T06:12:06.536Z (over 1 year ago)
- Topics: containerization, cursor-pagination, dotnet-core, entity-framework, pagination, sonarcloud, xunit
- Language: C#
- Homepage: https://www.nuget.org/packages/DrfLikePaginations/
- Size: 11.1 MB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# DRF Like Paginations
[](https://sonarcloud.io/dashboard?id=willianantunes_drf-like-paginations)
[](https://sonarcloud.io/dashboard?id=willianantunes_drf-like-paginations)
This project is an attempt to mimic [LimitOffsetPagination](https://www.django-rest-framework.org/api-guide/pagination/#limitoffsetpagination) and [CursorPagination](https://www.django-rest-framework.org/api-guide/pagination/#cursorpagination) that are available on DRF. Many other types of paginations can be incorporated beyond the ones available [here](https://www.django-rest-framework.org/api-guide/pagination/#api-reference). This is just a start.
dotnet add package DrfLikePaginations
It supports **queries in your data** given what is informed through the URL as query strings. You can get some details about how it works if you look at the tests in [LimitOffsetPaginationITests.Queries](https://github.com/willianantunes/drf-like-paginations/blob/6c4dc9ae2f00643514f3898d54ce085443788df3/tests/DrfLikePaginations/LimitOffsetPaginationITests.cs#L218) class.
It also support **model transformation**. If you don't want to expose your model, you can create a DTO and then provide a function which transforms your data. Check out one example on [this integration test](https://github.com/willianantunes/drf-like-paginations/blob/6c4dc9ae2f00643514f3898d54ce085443788df3/tests/DrfLikePaginations/LimitOffsetPaginationITests.cs#L353-L371).
The following project is using it and you can use as an example to set up yours:
- [Tic Tac Toe C# Playground](https://github.com/willianantunes/tic-tac-toe-csharp-playground)
## See it in action!
Sample GIF that shows `CursorPagination`:
Sample GIF that shows `LimitOffsetPagination`:
## How to use it
You can add the following in your `appsettings.json`:
```json
{
"Pagination": {
"Size": 5
}
}
```
Then configure the pagination service like the following for `LimitOffsetPagination`:
```csharp
var paginationSize = int.Parse(Configuration["Pagination:Size"]);
services.AddSingleton(new LimitOffsetPagination(paginationSize));
```
You can use `CursorPagination` also:
```csharp
var paginationSize = int.Parse(Configuration["Pagination:Size"]);
// It will consider the field "id" to order by default, but you can change it 😄
services.AddSingleton(new CursorPagination(paginationSize));
```
Now you are able to use it 😍! One full example:
```csharp
namespace EFCoreHandlingMigrations.Controllers.V1
{
[ApiController]
[Route("api/v1/[controller]")]
public class TodoItemsController : ControllerBase
{
private readonly DbSet _databaseSet;
private readonly IPagination _pagination;
public TodoItemsController(AppDbContext context, IPagination pagination)
{
_databaseSet = context.TodoItems;
_pagination = pagination;
}
[HttpGet]
public async Task> GetTodoItems()
{
// You just need to apply OrderBy when using LimitOffsetPagination
var query = _databaseSet.AsNoTracking().OrderBy(t => t.CreatedAt);
var displayUrl = Request.GetDisplayUrl();
var queryParams = Request.Query;
return await _pagination.CreateAsync(query, displayUrl, queryParams);
}
}
}
```
## Compose services
If you look at [docker-compose.yaml](https://github.com/willianantunes/drf-like-paginations/blob/abdce3ab9293af95d923cf0b25634f555fad4aaa/docker-compose.yaml#L7-L30), you'll find three main services:
- [tests](https://github.com/willianantunes/drf-like-paginations/blob/fff46e8627c1bfd23fcc2ef7fe9e8663e6e87156/docker-compose.yaml#L7): run all the tests, and generate tests-reports folder with coverage data.
- [lint](https://github.com/willianantunes/drf-like-paginations/blob/fff46e8627c1bfd23fcc2ef7fe9e8663e6e87156/docker-compose.yaml#L15): check if the project is valid given standard dotnet-format rules
- [formatter](https://github.com/willianantunes/drf-like-paginations/blob/fff46e8627c1bfd23fcc2ef7fe9e8663e6e87156/docker-compose.yaml#L23): format the project given standard dotnet-format rules