ドキュメント概要

ようこそ

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 … インストール Sisk を Nuget、dotnet cli、または他のオプションを介してインストールできます。開発者コンソールで次のコマンドを実行することで、Sisk 環境を簡単に設定できます： Shell dotnet add package Sisk.HttpServer このコマン … ネイティブAOTのサポート .NET Native AOTを使用すると、.NETランタイムがターゲットホストにインストールされていない場合でも、自己完結型のネイティブ.NETアプリケーションを公開できます。さらに、ネイティブAOTでは以下のような利点があります：アプリケーションのサイズが大幅に小さくなる … アプリケーションのデプロイ Sisk アプリケーションのデプロイプロセスは、プロジェクトを本番環境に公開することです。プロセスは比較的簡単ですが、セキュリティと安定性のために重要な詳細があります。理想的には、アプリケーションをテストして準備し、クラウドにデプロイする準備ができているはずです。アプリの公 … SSL の利用 開発時に SSL を利用する必要がある場合があります。これは、ほとんどの Web 開発シナリオのようにセキュリティが求められるコンテキストで作業する場合です。Sisk は HttpListener の上に構築されており、ネイティブの HTTPS はサポートせず HTTP のみを扱 … Cadente Cadenteは、Sisk用の実験的なマネージドHTTP/1.1リスナー実装です。デフォルトのSystem.Net.HttpListenerの代替として機能し、特に非Windowsプラットフォームでより大きな制御と柔軟性を提供します。概要 # デフォルトでは、Siskは … Windows での名前空間予約の構成 注記この構成はオプションであり、Windows で HttpListener エンジンを使用して「localhost」以外のホストで Sisk をリッスンさせたい場合にのみ必要です。 Sisk は HttpListener ネットワークインターフェイスと連携し、仮想ホストをシ … 変更履歴 Sisk に行われたすべての変更は、変更履歴を通じて記録されます。すべての Sisk バージョンの変更履歴をこちらで確認できます。 Frequently Asked Questions Sisk に関するよくある質問。 Sisk はオープンソースですか？ # 完全に。Sisk で使用されるすべてのソースコードは、GitHub で公開および頻繁に更新されています。貢献は受け付けますか？ # Sisk の哲学と互換性がある限り、すべての貢献は大歓迎です！貢献はコ …

基礎

ルーティング The Router はサーバー構築の最初のステップです。これは Route オブジェクトを保持する役割を担い、URL とそのメソッドをサーバーが実行するアクションにマッピングするエンドポイントです。各アクションはリクエストを受け取り、クライアントへレスポンスを返すことを担当しま … リクエストハンドリング リクエストハンドラは、“ミドルウェア” とも呼ばれ、ルーターでリクエストが実行される前後に実行される関数です。ルート単位またはルーター単位で定義できます。リクエストハンドラには2種類あります： BeforeResponse: ルーターアクションを呼び出す … リクエスト リクエストは HTTP リクエストメッセージを表す構造体です。 HttpRequest オブジェクトには、アプリケーション全体で HTTP メッセージを処理するための便利な機能が含まれています。 HTTP リクエストは、メソッド、パス、バージョン、ヘッダー、ボディで構成されます。 … Responses Responses は HTTP リクエストに対する HTTP レスポンスのオブジェクトを表します。サーバーはリソース、ページ、ドキュメント、ファイル、またはその他のオブジェクトへの要求の結果として、クライアントに送信します。 HTTP レスポンスはステータス、ヘッダー、コンテン …

機能

ロギング Sisk を構成して、アクセスログとエラーログを自動的に書き込むことができます。ログのローテーション、拡張子、頻度を定義することが可能です。 LogStream クラスは、非同期的にログを書き込み、await 可能な書き込みキューに保持する方法を提供します。LogStream ク … サーバー送信イベント Sisk は、Server Sent Events を使用したメッセージ送信を標準でサポートしています。使い捨ておよび永続的な接続を作成でき、実行時に接続を取得して使用することができます。この機能には、ブラウザーが課すいくつかの制限があります。たとえば、テキストメッセージのみ送 … Web ソケット Sisk は Web ソケットもサポートしており、クライアントとのメッセージの受信・送信が可能です。この機能はほとんどのブラウザで問題なく動作しますが、Sisk ではまだ実験的な段階です。バグを見つけた場合は、GitHub で報告してください。メッセージの受信 # … 捨てられる構文 HTTPサーバーは、OAuth認証などのアクションからのコールバック要求を待ち受けるために使用でき、要求を受け取った後には捨てられる。この機能は、バックグラウンドアクションが必要だが、HTTPアプリケーションを設定したくない場合に便利です。以下の例は … 依存性の注入 リクエストの有効期間中に存在するメンバーとインスタンス（たとえば、データベース接続、認証済みユーザー、またはセッショントークン）を指定することは一般的です。可能な方法の1つは、HttpContext.RequestBagを使用することです。これは、リクエストの有効期間中に存在する … コンテンツのストリーミング Sisk では、クライアントとの間でコンテンツのストリーミングを読み書きすることができます。この機能は、リクエストの生存期間中にコンテンツのシリアル化とデシリアル化のメモリ負荷を削減するために役立ちます。リクエストコンテンツストリーム # 小さなコンテンツは自動的に HTTP … SiskでのCORS（Cross-Origin Resource Sharing）を有効にする Siskには、公開されているサービスでCORS（Cross-Origin Resource Sharing）を処理するためのツールがあります。この機能は、HTTPプロトコルの一部ではなく、W3Cによって定義されたWebブラウザの特定の機能です。このセキュリティメカニズムは、Web … File Server Sisk は Sisk.Http.FileSystem 名前空間を提供し、静的ファイルの配信、ディレクトリ一覧表示、ファイル変換のツールが含まれます。この機能により、ローカルディレクトリからファイルを配信でき、レンジリクエスト（音声/動画ストリーミング）やカスタムファイル処理をサ …

拡張機能

モデルコンテキストプロトコル 大規模言語モデル（LLM）を使用してエージェントモデルにコンテキストを提供するアプリケーションを、Sisk.ModelContextProtocol パッケージで構築できます。 Bash dotnet add package Sisk.ModelContextProtocol こ … JSON-RPC 拡張 Sisk には JSON-RPC 2.0 API 用の実験的モジュールがあり、さらにシンプルなアプリケーションを作成できます。この拡張は JSON-RPC 2.0 のトランスポートインターフェースを厳密に実装し、HTTP GET、POST リクエストおよび Sisk の … SSL Proxy 警告この機能は実験的であり、運用環境では使用しないでください。Sisk を SSL で動作させる方法については、このドキュメントを参照してください。 Sisk SSL Proxy は、Sisk の ListeningHost に HTTPS 接続を提供し、HTTPS メッセ … Basic Auth Basic Authパッケージは、非常に少ない設定と労力で、Siskアプリケーションに基本認証スキームを処理できるリクエストハンドラーを追加します。 Basic HTTP認証は、ユーザーIDとパスワードでリクエストを認証する最小限の入力形式であり、セッションはクライアントによって … サービスプロバイダー サービスプロバイダーは、Sisk アプリケーションをさまざまな環境に移植するための方法です。この機能により、サーバーのポート、パラメーター、およびその他のオプションを変更できますが、アプリケーションコードを各環境用に変更する必要はありません。このモジュールは、Sisk の構築 … INI 構成プロバイダー Sisk には、JSON 以外の起動構成を取得する方法があります。実際には、IConfigurationReader を実装する任意のパイプラインを使用して、PortableConfigurationBuilder.WithConfigurationPipeline でサーバーの … API ドキュメント Sisk.Documenting 拡張機能を使用すると、Sisk アプリケーションの API ドキュメントを自動的に生成できます。コード構造や属性を利用して包括的なドキュメントサイトを作成し、Open API（Swagger）形式へのエクスポートをサポートします。警告このパッ …

詳細

手動（上級）セットアップ サーバーの部品を自分で組み立てる必要がある場合、たとえば 1 つのプロセスが複数のホスト、ポート、ルーター、またはカスタムサーバー構成を公開しなければならない場合に手動設定を使用します。ほとんどのアプリケーションでは、ビルダー API の方が短く、優先すべきです。手動設定は … リクエストのライフサイクル 以下では、HTTP リクエストの例を通して、リクエストの全ライフサイクルについて説明します。リクエストの受信: 各リクエストは、リクエスト自体とクライアントに配信されるレスポンスとの間に HTTP コンテキストを作成します。このコンテキストは Sisk の組み込みリスナーから提 … フォワーディングリゾルバ フォワーディングリゾルバは、リクエスト、プロキシ、CDN、ロードバランサーを通じてクライアントを識別する情報をデコードするのに役立つヘルパーです。Sisk サービスがリバースプロキシまたはフォワードプロキシを介して実行される場合、クライアントの IP アドレス、ホスト、プロトコル … Http server handlers Sisk バージョン 0.16 では、HttpServerHandler クラスを導入しました。このクラスは Sisk の全体的な動作を拡張し、Http リクエストの処理、ルーター、コンテキストバッグなど、追加のイベントハンドラを Sisk に提供することを目的としています。こ … サーバーあたり複数のリスニングホスト Sisk Framework は常にサーバーあたり複数のホストの使用をサポートしており、つまり単一の HTTP サーバーが複数のポートでリッスンでき、各ポートはそれぞれ独自のルーターとサービスを実行します。このように、Sisk を使用すると単一の HTTP サーバー上で責務を分 … HTTPサーバーエンジン Sisk Frameworkは複数のパッケージに分割されており、主なパッケージ（Sisk.HttpServer）は基本的なHTTPサーバーを含んでいません。デフォルトでは、HttpListenerがSiskの主なエンジンとして使用され、低レベルのサーバーの役割を果たします。 …