OpenAPI: part-level compression

Document per-part Content-Encoding with OpenAPI annotations.

Full source

File: pwsh/tutorial/examples/22.14-Part-Compressed-OpenAPI.ps1

<#!
    22.14-Part-Compressed-OpenAPI with part-level compression and OpenAPI (optional feature)

    Client example (PowerShell):
        $client = [System.Net.Http.HttpClient]::new()
        $content = [System.Net.Http.MultipartFormDataContent]::new()
        $raw = [System.Text.Encoding]::UTF8.GetBytes('compressed-part')
        $ms = [System.IO.MemoryStream]::new()
        $gzip = [System.IO.Compression.GZipStream]::new($ms, [System.IO.Compression.CompressionMode]::Compress, $true)
        $gzip.Write($raw, 0, $raw.Length)
        $gzip.Dispose()
        $compressed = $ms.ToArray()
        $part = [System.Net.Http.ByteArrayContent]::new($compressed)
        $part.Headers.ContentType = [System.Net.Http.Headers.MediaTypeHeaderValue]::Parse('text/plain')
        $part.Headers.ContentEncoding.Add('gzip')
        $content.Add($part,'file','payload.txt')
        $resp = $client.PostAsync("http://127.0.0.1:$Port/part-compressed", $content).Result
        $resp.Content.ReadAsStringAsync().Result

    Cleanup:
        Remove-Item -Recurse -Force (Join-Path ([System.IO.Path]::GetTempPath()) 'kestrun-uploads-22.14-part-compressed-openapi')
#>
param(
    [int]$Port = 5000,
    [IPAddress]$IPAddress = [IPAddress]::Loopback
)

New-KrLogger |
    Set-KrLoggerLevel -Value Debug |
    Add-KrSinkConsole |
    Register-KrLogger -Name 'console' -SetAsDefault

New-KrServer -Name 'Forms 22.14-Part-Compressed-OpenAPI'

Add-KrEndpoint -Port $Port -IPAddress $IPAddress

# =========================================================
#                 TOP-LEVEL OPENAPI
# =========================================================

Add-KrOpenApiInfo -Title 'Uploads 22.14-Part-Compressed-OpenAPI' `
    -Version '1.0.0' `
    -Description 'Per-part compression + multipart parsing using Add-KrFormRoute.'

Add-KrOpenApiContact -Email 'support@example.com'

# Set default upload path for form parts
$uploadRoot = Join-Path ([System.IO.Path]::GetTempPath()) 'kestrun-uploads-22.14-part-compressed-openapi'
Set-KrServerOptions -DefaultUploadPath $uploadRoot

[OpenApiSchemaComponent(Description = 'File upload form')]
[KrBindForm(ComputeSha256 = $true, EnablePartDecompression = $true, MaxDecompressedBytesPerPart = (1024 * 1024))]
class PartCompressed {
    [KrPart(Required = $true, ContentTypes = 'text/plain', AllowMultiple = $false)]
    [OpenApiProperty(Description = 'The file to upload', Format = 'binary')]
    [Kestrun.Forms.KrFilePart] $file
}

<#
.SYNOPSIS
    OpenAPI route function for /part-compressed
.DESCRIPTION
    OpenAPI route function for /part-compressed with KrBindForm and OpenAPI attributes
.PARAMETER FormPayload
    The form payload bound to the PartCompressed class
#>
function partcompressed {
    [OpenApiPath(HttpVerb = 'post', Pattern = '/part-compressed')]
    [OpenApiResponse(  StatusCode = '200', Description = 'Parsed fields and files', ContentType = 'application/json')]

    param(
        [OpenApiRequestBody(contentType = ('multipart/form-data'), Required = $true)]
        [PartCompressed] $FormPayload
    )
    $file = $FormPayload.file
    Write-KrJsonResponse -InputObject @{ fileName = $file.OriginalFileName; length = $file.Length; sha256 = $file.Sha256 } -StatusCode 200
}

Enable-KrConfiguration

# =========================================================
#                OPENAPI DOC ROUTE / UI
# =========================================================

Add-KrOpenApiRoute -SpecVersion OpenApi3_2

Add-KrApiDocumentationRoute -DocumentType Swagger -OpenApiEndpoint '/openapi/v3.2/openapi.json'
Add-KrApiDocumentationRoute -DocumentType Redoc -OpenApiEndpoint '/openapi/v3.2/openapi.json'

# Start the server asynchronously
Start-KrServer -CloseLogsOnExit

Step-by-step

Logger: Register a console logger for visibility.
Server: Create the host and bind a listener.
OpenAPI: Add document info and contact metadata.
Storage: Set the default upload directory.
Model: Enable part decompression in KrBindForm.
Route: Declare /part-compressed with [OpenApiPath] and [OpenApiRequestBody].
Docs: Register the OpenAPI route and documentation UIs.
Start: Launch the server.

Try it

$client = [System.Net.Http.HttpClient]::new()
$content = [System.Net.Http.MultipartFormDataContent]::new()
$raw = [System.Text.Encoding]::UTF8.GetBytes('compressed-part')
$ms = [System.IO.MemoryStream]::new()
$gzip = [System.IO.Compression.GZipStream]::new($ms, [System.IO.Compression.CompressionMode]::Compress, $true)
$gzip.Write($raw, 0, $raw.Length)
$gzip.Dispose()
$compressed = $ms.ToArray()
$part = [System.Net.Http.ByteArrayContent]::new($compressed)
$part.Headers.ContentType = [System.Net.Http.Headers.MediaTypeHeaderValue]::Parse('text/plain')
$part.Headers.ContentEncoding.Add('gzip')
$content.Add($part,'file','payload.txt')
$resp = $client.PostAsync('http://127.0.0.1:5000/part-compressed', $content).Result
$resp.Content.ReadAsStringAsync().Result

printf 'compressed-part' > payload.txt
gzip -c payload.txt > payload.gz
curl -F "file=@payload.gz;type=text/plain;headers=Content-Encoding: gzip" http://127.0.0.1:5000/part-compressed

OpenAPI: part-level compression

Full source

Step-by-step

Try it

Troubleshooting

References

Previous / Next