リクエスト¶
Request オブジェクトは、すべてのルートハンドラに渡されます。
app.get("hello", ":name") { req -> String in
let name = req.parameters.get("name")!
return "Hello, \(name)!"
}
これは、Vaporの他の機能への主要な窓口です。リクエストボディ、クエリパラメータ、ロガー、HTTPクライアント、AuthenticatorなどのAPIが含まれています。リクエストを通じてこれらの機能にアクセスすることで、計算を適切なイベントループ上に保ち、テスト用にモック化することができます。拡張機能を使用して、独自のサービスをRequestに追加することもできます。
Requestの完全なAPIドキュメントはこちらで確認できます。
アプリケーション¶
Request.applicationプロパティは、Applicationへの参照を保持しています。このオブジェクトには、アプリケーションのすべての設定とコア機能が含まれています。そのほとんどは、アプリケーションが完全に起動する前のconfigure.swiftでのみ設定されるべきであり、低レベルAPIの多くはほとんどのアプリケーションでは必要ありません。最も便利なプロパティの1つはApplication.eventLoopGroupで、新しいEventLoopが必要なプロセスのためにany()メソッドを介してEventLoopを取得するために使用できます。また、Environmentも含まれています。
ボディ¶
リクエストボディにByteBufferとして直接アクセスしたい場合は、Request.body.dataを使用できます。これは、リクエストボディからファイルへのデータのストリーミング(ただし、この場合はリクエストのfileioプロパティを使用すべきです)や、別のHTTPクライアントへの転送に使用できます。
クッキー¶
クッキーの最も便利な用途は組み込みのセッションを経由することですが、Request.cookiesを介してクッキーに直接アクセスすることもできます。
app.get("my-cookie") { req -> String in
guard let cookie = req.cookies["my-cookie"] else {
throw Abort(.badRequest)
}
if let expiration = cookie.expires, expiration < Date() {
throw Abort(.badRequest)
}
return cookie.string
}
ヘッダー¶
HTTPHeadersオブジェクトはRequest.headersでアクセスできます。これには、リクエストとともに送信されたすべてのヘッダーが含まれています。例えば、Content-Typeヘッダーにアクセスするために使用できます。
app.get("json") { req -> String in
guard let contentType = req.headers.contentType, contentType == .json else {
throw Abort(.badRequest)
}
return "JSON"
}
HTTPHeadersの詳細なドキュメントはこちらを参照してください。Vaporは、最もよく使用されるヘッダーの操作を簡単にするために、HTTPHeadersにいくつかの拡張機能も追加しています。リストはこちらで確認できます。
IPアドレス¶
クライアントを表すSocketAddressはRequest.remoteAddressを介してアクセスでき、ログ記録やレート制限のために文字列表現Request.remoteAddress.ipAddressを使用すると便利です。アプリケーションがリバースプロキシの背後にある場合、クライアントのIPアドレスを正確に表していない可能性があります。
app.get("ip") { req -> String in
return req.remoteAddress.ipAddress
}
SocketAddressの詳細なドキュメントはこちらを参照してください。