Ktor ドキュメント
Ktor は、非同期のサーバーサイドおよびクライアントサイドアプリケーションを容易に構築するためのフレームワークです。
Ktor Server
サーバーの設定
新規 Ktor プロジェクトの作成、オープン、実行Ktor を使用したサーバーアプリケーションの開き方、実行方法、テスト方法について学びます。サーバーの依存関係の追加既存のGradle/MavenプロジェクトにKtorサーバーの依存関係を追加する方法を学びます。サーバーの作成アプリケーションのデプロイのニーズに応じてサーバーを作成する方法を学びます。コードでの設定コード内でさまざまなサーバーパラメータを設定する方法を学びます。ファイルでの設定構成ファイルでさまざまなサーバーパラメータを設定する方法について説明します。サーバープラグインプラグインは、シリアライゼーション、コンテンツエンコーディング、圧縮などの一般的な機能を提供します。
ルーティング
ルーティングルーティングは、サーバーアプリケーションにおいて着信リクエストを処理するためのコアとなるプラグインです。型安全なルーティングResourcesプラグインを使用すると、型安全なルーティングを実装できます。ルーティングの構成Ktorアプリケーションの成長に合わせて、ルーティングロジックをどのように構成し、構造化するかを学びます。リクエストの処理ルートハンドラー内で受信リクエストを処理する方法について説明します。レスポンスの送信さまざまなタイプのレスポンスを送信する方法について説明します。静的コンテンツの配信スタイルシート、スクリプト、画像などの静的コンテンツを配信する方法を学びます。
プラグイン
Ktor Server でのコンテンツネゴシエーションとシリアライズContentNegotiation プラグインには、主に2つの目的があります。クライアントとサーバー間でのメディアタイプのネゴシエーション、および特定の形式でのコンテンツのシリアライズ/デシリアライズです。テンプレートHTML/CSS または JVM テンプレートエンジンを使用して構築されたビューを扱う方法を学びます。Ktor Server での認証と認可Authenticationプラグインは、Ktorにおける認証と認可を処理します。セッションSessions プラグインは、異なる HTTP リクエスト間でデータを永続化するメカニズムを提供します。Ktor Server での WebSocketWebsockets プラグインを使用すると、サーバーとクライアント間で双方向の通信セッションを作成できます。Ktor Server での Server-Sent EventsSSE プラグインを使用すると、サーバーは HTTP 接続を介してイベントベースの更新をクライアントに送信できます。Swagger UISwaggerUIプラグインを使用すると、プロジェクト用のSwagger UIを生成できます。 / OpenAPIOpenAPIプラグインを使用すると、プロジェクト用のOpenAPIドキュメントを生成できます。カスタムサーバープラグイン独自のカスタムプラグインを作成する方法を学びます。
実行、デバッグ、テスト
実行Ktor サーバーアプリケーションを実行する方法を学びます。自動リロードオートリロードを使用して、コードの変更時にアプリケーションクラスをリロードする方法を学びます。Ktor Server でのテスト特別なテストエンジンを使用してサーバーアプリケーションをテストする方法を学びます。
デプロイ
Fat JAR の作成Ktor Gradleプラグインを使用して実行可能なfat JARを作成および実行する方法を学びます。WARWARアーカイブを使用して、サーブレットコンテナ内でKtorアプリケーションを実行およびデプロイする方法を学びます。GraalVMさまざまなプラットフォームでネイティブイメージを作成するためにGraalVMを使用する方法を学びます。Dockerアプリケーションを Docker コンテナにデプロイする方法を学びます。Ktor アプリを Google App Engine にデプロイプロジェクトを Google App Engine スタンダード環境にデプロイする方法を学びます。HerokuKtorアプリケーションをHerokuにデプロイするための準備とデプロイ方法について学びます。SevallaKtorアプリケーションをSevallaに準備してデプロイする方法を学びます。
Ktor Client
クライアントのセットアップ
クライアントアプリケーションの作成リクエストを送信してレスポンスを受信する、最初のクライアントアプリケーションを作成します。クライアントの依存関係の追加既存のプロジェクトにクライアントの依存関係を追加する方法を学びます。クライアントの作成と設定Ktorクライアントの作成と設定方法について学びます。クライアントエンジンネットワークリクエストを処理するエンジンについて学びます。クライアントプラグインクライアントプラグインを使用して、ロギング、シリアライズ、認可などの共通機能を追加する方法を学びます。
リクエスト
リクエストの作成リクエストの送信方法と、リクエストURL、HTTPメソッド、ヘッダー、リクエストボディなどのさまざまなリクエストパラメータの指定方法について学びます。型安全なリクエストResources プラグインを使用して型安全なリクエストを行う方法を学びます。デフォルトリクエストDefaultRequest プラグインを使用すると、すべてのリクエストに対するデフォルトのパラメータを設定できます。失敗したリクエストの再試行HttpRequestRetry プラグインを使用すると、失敗したリクエストに対する再試行ポリシーを設定できます。
レスポンス
プラグイン
Ktor Client での認証と認可Auth プラグインは、クライアントアプリケーションにおける認証と認可を処理します。CookieHttpCookies プラグインは Cookie を自動的に処理し、ストレージ内に呼び出し間で保持します。コンテンツエンコーディングContentEncoding プラグインを使用すると、指定した圧縮アルゴリズム('gzip' や 'deflate' など)を有効にし、その設定を行うことができます。BOM リムーバーBOMRemover プラグインを使用すると、レスポンスボディからバイト順マーク(BOM)を削除できます。キャッシュHttpCacheプラグインを使用すると、以前に取得したリソースをインメモリまたは永続キャッシュに保存できます。Ktor Client での WebSocketWebsocketsプラグインを使用すると、サーバーとクライアント間で双方向通信セッションを作成できます。Ktor Client での Server-Sent EventsSSE プラグインを使用すると、クライアントは HTTP 接続を介してサーバーからイベントベースの更新を受信できます。カスタムクライアントプラグイン独自のカスタムクライアントプラグインを作成する方法を学びます。
テスト
Ktor Client でのテストMockEngine を使用して HTTP 呼び出しをシミュレートし、クライアントをテストする方法を学びます。
