Getting started

Welcome to the Sisk documentation!

Sisk is an open-source lightweight HTTP framework for .NET. You can use it to build a standalone web service, embed an HTTP module inside an existing application, or run a service behind a reverse proxy with only the configuration you need.

Sisk’s values include code transparency, modularity, performance, and scalability. It can handle different application styles, including RESTful APIs, JSON-RPC services, WebSockets, Server-Sent Events, and static file serving.

It’s main features includes：

リソース	説明
Routing	プレフィックス、カスタムメソッド、パス変数、値コンバータなどをサポートするパスルーターです。
Request Handlers	ミドルウェアとも呼ばれ、アクションの前後でリクエストと連携する独自のリクエストハンドラを構築するためのインターフェースを提供します。
Compression	Sisk を使ってレスポンス内容を簡単に圧縮できます。
Web sockets	クライアントとの読み書きが可能な完全な WebSocket を受け入れるルートを提供します。
Server-sent events	SSE プロトコルをサポートするクライアントへサーバーイベントを送信する機能を提供します。
Logging	シンプルなロギング。エラーやアクセスのログ、サイズでローテーションするログ、同一ログへの複数出力ストリームなどを定義できます。
Multi-host	複数ポート用の HTTP サーバーを持ち、各ポートが独自のルーターを、各ルーターが独自のアプリケーションを持ちます。
Server handlers	HTTP サーバーの独自実装を拡張します。拡張機能や改善、新機能でカスタマイズできます。

最初のステップ #

Sisk は任意の .NET 環境で実行できます。このガイドでは、.NET を使用して Sisk アプリケーションを作成する方法を説明します。まだインストールしていない場合は、こちらから SDK をダウンロードしてください。

このチュートリアルでは、プロジェクト構成の作成、リクエストの受信、URL パラメータの取得、レスポンスの送信方法を扱います。このガイドは C# を使用したシンプルなサーバー構築に焦点を当てています。好きなプログラミング言語でも使用できます。

注記

クイックスタートプロジェクトに興味があるかもしれません。詳細はこのリポジトリをご確認ください。

プロジェクトの作成 #

プロジェクト名を「My Sisk Application」にしましょう。.NET の環境が整ったら、次のコマンドでプロジェクトを作成できます：

Bash

dotnet new console -n my-sisk-application

次に、プロジェクトディレクトリへ移動し、.NET ユーティリティツールで Sisk をインストールします：

Bash

cd my-sisk-application
dotnet add package Sisk.HttpServer

プロジェクトに Sisk をインストールする他の方法は、こちらにあります。

それでは、HTTP サーバーのインスタンスを作成しましょう。この例ではポート 5000 でリッスンするように設定します。

HTTP サーバーの構築 #

Sisk は HttpServer オブジェクトへルーティングする形で、手動でステップバイステップにアプリケーションを構築できますが、ほとんどのプロジェクトではあまり便利ではありません。そのため、ビルダーメソッドを使用すれば、アプリを簡単に起動できます。

Program.csC#

class Program
{
    static async Task Main(string[] args)
    {
        using var app = HttpServer.CreateBuilder()
            .UseListeningPort("http://localhost:5000/")
            .Build();
        
        app.Router.MapGet("/", request =>
        {
            return new HttpResponse()
            {
                Status = 200,
                Content = new StringContent("Hello, world!")
            };
        });
        
        await app.StartAsync();
    }
}

Sisk の重要なコンポーネントを理解することが重要です。このドキュメントの後半で、Sisk の仕組みについてさらに学べます。

手動（高度）設定 #

ドキュメントのこのセクションでは、HttpServer、Router、ListeningPort など各コンポーネントの動作と関係性について学べます。