Ktorドキュメント
Ktorは、非同期のサーバーサイドおよびクライアントサイドアプリケーションを簡単に構築するためのフレームワークです。
Ktorサーバー
サーバー設定
新しいKtorプロジェクトを作成、開いて実行する
Ktorでサーバーアプリケーションを開き、実行し、テストする方法を学びます。
サーバーの依存関係を追加する
既存のGradle/MavenプロジェクトにKtorサーバーの依存関係を追加する方法を学びます。
サーバーを作成する
アプリケーションのデプロイ要件に応じてサーバーを作成する方法を学びます。
コードでの設定
コードで様々なサーバーパラメータを設定する方法を学びます。
ファイルでの設定
設定ファイルで様々なサーバーパラメータを設定する方法を学びます。
サーバープラグイン
プラグインは、シリアル化、コンテンツエンコーディング、圧縮などの共通機能を提供します。
ルーティング
ルーティング
ルーティングは、サーバーアプリケーションで受信リクエストを処理するためのコアプラグインです。
型安全なルーティング
Resourcesプラグインを使用すると、型安全なルーティングを実装できます。
アプリケーションの構造
アプリケーションの成長に合わせて、保守しやすい構造にする方法を学びます。
リクエストの処理
ルートハンドラ内で受信リクエストを処理する方法を学びます。
レスポンスの送信
異なる種類のレスポンスを送信する方法を学びます。
静的コンテンツの提供
スタイルシート、スクリプト、画像などの静的コンテンツを提供する方法を学びます。
プラグイン
Ktorサーバーでのコンテンツネゴシエーションとシリアル化
ContentNegotiationプラグインには2つの主な目的があります。クライアントとサーバー間のメディアタイプをネゴシエートすることと、特定の形式でコンテンツをシリアル化/デシリアル化することです。
テンプレート
HTML/CSSまたはJVMテンプレートエンジンで構築されたビューを操作する方法を学びます。
Ktorサーバーでの認証と認可
AuthenticationプラグインはKtorでの認証と認可を処理します。
セッション
Sessionsプラグインは、異なるHTTPリクエスト間でデータを永続化するメカニズムを提供します。
KtorサーバーでのWebSockets
WebSocketsプラグインを使用すると、サーバーとクライアント間で多方向通信セッションを作成できます。
KtorサーバーでのServer-Sent Events
SSEプラグインを使用すると、サーバーはHTTP接続を介してクライアントにイベントベースの更新を送信できます。
Swagger UI
/ SwaggerUIプラグインを使用すると、プロジェクトのSwagger UIを生成できます。
OpenAPI
OpenAPIプラグインを使用すると、プロジェクトのOpenAPIドキュメントを生成できます。
カスタムサーバープラグイン
独自のカスタムプラグインを作成する方法を学びます。
実行、デバッグ、テスト
実行
Ktorサーバーアプリケーションを実行する方法を学びます。
自動リロード
Auto-reloadを使用して、コード変更時にアプリケーションクラスをリロードする方法を学びます。
Ktorサーバーでのテスト
特別なテストエンジンを使用してサーバーアプリケーションをテストする方法を学びます。
デプロイ
Fat JARの作成
Ktor Gradleプラグインを使用して、実行可能なfat JARを作成および実行する方法を学びます。
WAR
WARアーカイブを使用して、サーブレットコンテナ内でKtorアプリケーションを実行およびデプロイする方法を学びます。
GraalVM
様々なプラットフォームでネイティブイメージにGraalVMを使用する方法を学びます。
Docker
アプリケーションをDockerコンテナにデプロイする方法を学びます。
Google App Engine
Google App Engine標準環境にプロジェクトをデプロイする方法を学びます。
Heroku
HerokuにKtorアプリケーションを準備およびデプロイする方法を学びます。
Ktorクライアント
クライアントのセットアップ
クライアントアプリケーションを作成する
リクエストを送信し、レスポンスを受信するための最初のクライアントアプリケーションを作成します。
クライアントの依存関係を追加する
既存のプロジェクトにクライアントの依存関係を追加する方法を学びます。
クライアントの作成と設定
Ktorクライアントを作成および設定する方法を学びます。
クライアントエンジン
ネットワークリクエストを処理するエンジンについて学びます。
クライアントプラグイン
ロギング、シリアル化、認可などの共通機能を提供するプラグインについて理解を深めます。
リクエスト
リクエストの作成
リクエストの作成方法と、リクエストURL、HTTPメソッド、ヘッダー、リクエスト本文など、様々なリクエストパラメータを指定する方法を学びます。
型安全なリクエスト
Resourcesプラグインを使用して型安全なリクエストを作成する方法を学びます。
デフォルトリクエスト
DefaultRequestプラグインを使用すると、すべてのリクエストのデフォルトパラメータを設定できます。
失敗したリクエストの再試行
HttpRequestRetryプラグインを使用すると、失敗したリクエストの再試行ポリシーを設定できます。
レスポンス
プラグイン
Ktorクライアントでの認証と認可
Authプラグインは、クライアントアプリケーションでの認証と認可を処理します。
クッキー
HttpCookiesプラグインはクッキーを自動的に処理し、ストレージで呼び出し間で保持します。
コンテンツエンコーディング
ContentEncodingプラグインを使用すると、指定された圧縮アルゴリズム（「gzip」や「deflate」など）を有効にし、その設定を構成できます。
BOMリムーバー
BOMRemoverプラグインを使用すると、レスポンス本文からバイトオーダーマーク (BOM) を削除できます。
キャッシング
HttpCacheプラグインを使用すると、以前にフェッチしたリソースをインメモリまたは永続キャッシュに保存できます。
KtorクライアントでのWebSockets
Websocketsプラグインを使用すると、サーバーとクライアント間で多方向通信セッションを作成できます。
KtorクライアントでのServer-Sent Events
SSEプラグインを使用すると、クライアントはHTTP接続を介してサーバーからイベントベースの更新を受信できます。
カスタムクライアントプラグイン
独自のカスタムクライアントプラグインを作成する方法を学びます。
テスト
Ktorクライアントでのテスト
MockEngineを使用してHTTP呼び出しをシミュレートすることにより、クライアントをテストする方法を学びます。