https://github.com/hashload/horse-compression
Middleware for Compression in HORSE
https://github.com/hashload/horse-compression
compression horse middleware
Last synced: 4 months ago
JSON representation
Middleware for Compression in HORSE
- Host: GitHub
- URL: https://github.com/hashload/horse-compression
- Owner: HashLoad
- License: mit
- Created: 2019-08-28T00:05:05.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-19T13:10:03.000Z (almost 2 years ago)
- Last Synced: 2024-04-14T00:32:23.587Z (about 1 year ago)
- Topics: compression, horse, middleware
- Language: Pascal
- Homepage: https://horse.hashload.com
- Size: 55.7 KB
- Stars: 32
- Watchers: 10
- Forks: 14
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# horse-compression
horse-compression is a official middleware for compressing content in APIs developed with the Horse framework.
We created a channel on Telegram for questions and support:
## ⚙️ Installation
Installation is done using the [`boss install`](https://github.com/HashLoad/boss) command:
``` sh
boss install horse-compression
```
If you choose to install manually, simply add the following folders to your project, in *Project > Options > Resource Compiler > Directories and Conditionals > Include file search path*
```
../horse-compression/src
```
## ✔️ Compatibility
This middleware is compatible with projects developed in:
- [X] Delphi
- [X] Lazarus
## ☑️ Compression types
Currently, the middleware is prepared to compress the data using DEFLATE and GZIP.
| Type | Delphi | Lazarus |
| -------- | -------------------- | --------------------------- |
| DEFLATE | ✔️ | ✔️ |
| GZIP | ✔️ | ❌ |
## ⚡️ Quickstart Delphi
```delphi
uses
Horse,
Horse.Jhonson,
Horse.Compression, // It's necessary to use the unit
System.JSON;
begin
THorse
.Use(Compression()) // Must come before Jhonson middleware
.Use(Jhonson);
// You can set compression threshold:
// THorse.Use(Compression(1024));
THorse.Get('/ping',
procedure(Req: THorseRequest; Res: THorseResponse; Next: TProc)
var
I: Integer;
LPong: TJSONArray;
begin
LPong := TJSONArray.Create;
for I := 0 to 1000 do
LPong.Add(TJSONObject.Create(TJSONPair.Create('ping', 'pong')));
Res.Send(LPong);
end);
THorse.Listen(9000);
end;
```
## ⚡️ Quickstart Lazarus
```delphi
{$MODE DELPHI}{$H+}
uses
{$IFDEF UNIX}{$IFDEF UseCThreads}
cthreads,
{$ENDIF}{$ENDIF}
Horse,
Horse.Jhonson,
Horse.Compression, // It's necessary to use the unit
fpjson,
SysUtils;
procedure GetPing(Req: THorseRequest; Res: THorseResponse; Next: TNextProc);
var
I: Integer;
LPong: TJSONArray;
LJson: TJSONObject;
begin
LPong := TJSONArray.Create;
for I := 0 to 1000 do
begin
LJson := TJSONObject.Create;
LJson.Add('ping', 'pong');
LPong.Add(LJson);
end;
Res.Send(LPong);
end;
begin
THorse
.Use(Compression()) // Must come before Jhonson middleware
.Use(Jhonson);
// You can set compression threshold:
// THorse.Use(Compression(1024));
THorse.Get('/ping', GetPing);
THorse.Listen(9000);
end.
```
## 🚀 Statistics
Using middleware, the response was approximately 67 turn smaller. Data were collected using the project available within the [samples (delphi)](https://github.com/HashLoad/horse-compression/tree/master/samples/delphi) folder. To default, responses less than or equal to 1024 bytes will not be compressed.
Property | Without | With
:---------: | ------: | ------:
Time(ms) | 108 | 126
Size(bytes) | 15.770 | 236
## ⚠️ License
`horse-compression` is free and open-source middleware licensed under the [MIT License](https://github.com/HashLoad/horse-compression/blob/master/LICENSE).