Horse CSResponsePagination

Horse-CsrePensePagination

Middleware do servidor de cavalos para pagar dados JSON no Restfull da APIs

Para instalar em seu projeto usando o chefe:

$ boss install https://github.com/claudneysessa/Horse-CSResponsePagination

Uso

Se você estiver usando o middleware Jhonson, sua declaração deve vir antes da declaração de Jhonson e, se você também usar o middleware de compressão, sua declaração deverá vir após a declaração de compressão.

  THorse
    .Use(Compression())
    .Use(CSResponsePagination()) // <<-- Here!
    .Use(Jhonson);

Primeiros passos

Para ativar a paginação dos dados, basta informar o cabeçalho da requisição os seguintes parâmetros:

Parâmetro	tipo	descrição
limite	Inteiro	Número de registros por página
desvio	Inteiro	página a ser exibida

Exemplo de servidor de cavalos usando o CSResponsePagination:

 uses

  Horse,
  Horse.Compression,
  Horse.Jhonson,
  Horse.CSResponsePagination,

  System.SysUtils,
  System.JSON,

  DBClient,
  DataSet.Serialize;

begin
  THorse
    .Use(Compression())
    .Use(CSResponsePagination())
    .Use(Jhonson);

  THorse.Get( ' /testeCSPagination ' ,
    procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
    var
      DataSet: TClientDataSet;
    begin
      DataSet := TClientDataSet.Create( nil );
      try
        DataSet.LoadFromFile( ' dataSetExample.xml ' );
        Res.Send<TJsonArray>(DataSet.ToJsonArray);
      finally
        DataSet.Free;
      end ;
    end );

  THorse.Listen( 8888 );

end .

Resultado no Jsonbody

Ao optar por usar a paginação no corpo do resultado, a CSResponsePagination gerará um retorno personalizado, apresentando os dados da paginação no corpo do resultado.

Campo	descrição
contar	Número total de registros
páginas	Páginas totais existentes
limite	Número total de registros por página
desvio	Página selecionada
tamanho	Número de registros para a página selecionada
dados	Matriz de resultados

Resultado JSON:

{
    "count" : 564 ,
    "pages" : 113 ,
    "limit" : 5 ,
    "offset" : 2 ,
    "size" : 5 ,
    "data" : []
}

Código de exemplo:

 begin
  THorse
    .Use(Compression())
    .Use(CSResponsePagination(false)) // <<-- paginateOnHeaders = false
    .Use(Jhonson);

  THorse.Get( ' /testeCSPagination ' ,
    procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
    var
      DataSet: TClientDataSet;
    begin
      DataSet := TClientDataSet.Create( nil );
      try
        DataSet.LoadFromFile( ' dataSetExample.xml ' );
        Res.Send<TJsonArray>(DataSet.ToJsonArray);
      finally
        DataSet.Free;
      end ;
    end );

  THorse.Listen( 8888 );

end .

Resultado em cabeçalhos de resposta

Ao optar por usar a paginação no cabeçalho da resposta, a CSResponsePagination gerará algumas informações personalizadas que apresentam os dados no cabeçalho da resposta.

Campo	descrição
Contagem X-Paginação	Número total de registros
Páginas-X-Paginação	Páginas totais existentes
X-PAGINA-LIMIT	Número total de registros por página
Offset X-Paginação	Página selecionada
X-PAGINAÇÃO	Número de registros para a página selecionada

Código de exemplo:

 begin
  THorse
    .Use(Compression())
    .Use(CSResponsePagination(true)) // <<-- paginateOnHeaders = true
    .Use(Jhonson);

  THorse.Get( ' /testeCSPagination ' ,
    procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
    var
      DataSet: TClientDataSet;
    begin
      DataSet := TClientDataSet.Create( nil );
      try
        DataSet.LoadFromFile( ' dataSetExample.xml ' );
        Res.Send<TJsonArray>(DataSet.ToJsonArray);
      finally
        DataSet.Free;
      end ;
    end );

  THorse.Listen( 8888 );

end .

Usando o objeto de configuração

Se houver necessidade de modificar a descrição dos elementos de resposta, existe o objeto de configuração que pode ser usado incluindo a unidade [Horse.csResponsePagination.types.pas] na unidade API, como mostrado no exemplo abaixo.

Dessa forma, podemos alterar a descrição do retorno via corpo e o retorno via resposta.

Código de exemplo:

 var
  PaginationConfig: TPaginationConfig;

begin

  PaginationConfig := TPaginationConfig.Create;

  PaginationConfig.paginateOnHeaders := False;
  PaginationConfig.body.count := ' count ' ;
  PaginationConfig.body.page := ' pages ' ;
  PaginationConfig.body.limit := ' limit ' ;
  PaginationConfig.body.offset := ' offset ' ;
  PaginationConfig.body.size := ' size ' ;
  PaginationConfig.body.data := ' data ' ;
  
  // or

  PaginationConfig.paginateOnHeaders := True;
  PaginationConfig.header.count := ' X-Total-Count ' ;
  PaginationConfig.header.page := ' X-Total-Pages ' ;
  PaginationConfig.header.limit := ' X-Page-Limit ' ;
  PaginationConfig.header.offset := ' X-Page-Offset ' ;
  PaginationConfig.header.size := ' X-Page-Size ' ;

  THorse
    .Use(Compression())
    .Use(CSResponsePagination(PaginationConfig))
    .Use(Jhonson);

  THorse.Get( ' /testeCSPagination ' ,
    procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
    var
      DataSet: TClientDataSet;
    begin
      DataSet := TClientDataSet.Create( nil );
      try
        DataSet.LoadFromFile( ' dataSetExample.xml ' );
        Res.Send<TJsonArray>(DataSet.ToJsonArray);
      finally
        DataSet.Free;
      end ;
    end );

  THorse.Listen( 8888 );

end .