Horse CSResponsePagination

Лошадь-CSREPONSEPAGINATION

Промежуточное программное обеспечение Horse Server для подкидки данных JSON в RESTFULL APIS

Для установки в вашем проекте с помощью босса:

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

Использование

Если вы используете промежуточное программное обеспечение Jhonson, ваше объявление должно быть представлено до объявления Джонсона, и если вы также используете промежуточное программное обеспечение для сжатия, ваше объявление должно произойти после объявления сжатия.

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

Первые шаги

Чтобы включить пьесу данных, просто сообщите заголовок заявки следующие параметры:

Параметр	тип	описание
предел	целое число	Количество записей на страницу
компенсировать	целое число	страница для отображения

Образец конного сервера с использованием 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 .

Результат на jsonbody

При выборе использования страниц в корпусе результата CSResponsePAGINATION будет генерировать индивидуальный возврат, представляющий данные о странице в корпусе результата.

Поле	описание
считать	Общее количество записей
страницы	Общие существующие страницы
предел	Общее количество записей на страницу
компенсировать	Выбранная страница
размер	Количество записей для выбранной страницы
данные	Результат массив

Json результат:

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

Пример кода:

 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 .

Результат на заголовки ответов

При выборе использования страниц в заголовке ответа CSResponsePagination генерирует некоторую персонализированную информацию, представляющую данные в заголовке ответа.

Поле	описание
X-Pagination-Count	Общее количество записей
X-pagination-страницы	Общие существующие страницы
X-Pagination-Limit	Общее количество записей на страницу
X-Pagination-Offet	Выбранная страница
X-Pagination-Size	Количество записей для выбранной страницы

Пример кода:

 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 .

Использование объекта конфигурации

Если необходимо изменить описание элементов ответа, существует объект конфигурации, который можно использовать путем включения блока [horse.csresponsepancemantal.types.pas] в блок API, как показано в примере ниже.

Таким образом, мы можем изменить описание как возврата через тело, так и возврат через HepplyHeaders.

Пример кода:

 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 .