Skip to content

Vapor

Core

Vapor VaporMacros beta AsyncKit RoutingKit ConsoleKit ConsoleKitCommands ConsoleKitTerminal ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Database

Fluent FluentKit FluentSQL FluentPostgresDriver FluentMongoDriver FluentMySQLDriver FluentSQLiteDriver SQLKit PostgresKit MySQLKit SQLiteKit PostgresNIO MySQLNIO SQLiteNIO Redis

Queues

Queues QueuesRedisDriver

Push Notifications

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

5.0 (beta)

4.x 5.0 (beta) beta

Vapor

Classes
Application
CORSMiddleware
EndpointCache
- Initializers
- init(uri: URI, client: any Client)
- Instance Methods
- func get() async throws -> T
- func get(using: any Client) async throws -> T
ErrorMiddleware
- Initializers
- init(@Sendable (Request, any Error) -> (Response))
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) async throws -> Response
- Type Methods
- static func `default`(environment: Environment) -> ErrorMiddleware
FileETagHashCache
FileMiddleware
MetricsMiddleware
- Initializers
- init()
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) async throws -> Response
RouteLoggingMiddleware
- Initializers
- init(logLevel: Logger.Level)
- Instance Properties
- let logLevel: Logger.Level
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) async throws -> Response
Session
- Initializers
- init(id: SessionID?, data: SessionData)
- Instance Properties
- var data: SessionData
- var id: SessionID?
- Instance Methods
- func authenticate<A>(A)
- func authenticated<A>(A.Type) -> A.SessionID?
- func destroy()
- func unauthenticate<A>(A.Type)
SessionsMiddleware
- Initializers
- init(session: any SessionDriver, configuration: SessionsConfiguration)
- Instance Properties
- let session: any SessionDriver
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) async throws -> Response
TracingMiddleware
- Initializers
- init(setCustomAttributes: @Sendable (inout SpanAttributes, Request) -> Void)
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) async throws -> Response
Protocols
AbortError
AnyOptionalType
Authenticatable
BasicAuthenticator
- Instance Properties
- var realm: String
  - BasicAuthenticator Implementations
  - var realm: String
- Instance Methods
- func authenticate(basic: BasicAuthorization, for: Request) async throws
BearerAuthenticator
- Instance Properties
- var realm: String
  - BearerAuthenticator Implementations
  - var realm: String
- Instance Methods
- func authenticate(bearer: BearerAuthorization, for: Request) async throws
Cache
Client
Content
ContentContainer
- Instance Properties
- var contentConfiguration: ContentConfiguration
- var contentType: HTTPMediaType?
- Instance Methods
- func decode(_:)
- func decode(_:as:)
- func decode<D>(D.Type, using: any ContentDecoder) async throws -> D
- func encode(_:)
- func encode(_:as:)
- func encode(some Encodable, using: any ContentEncoder) throws
- func get(_:at:)
- Subscripts
- subscript(_:at:)
ContentDecoder
- Instance Methods
- func decode<D>(D.Type, from: Data, headers: HTTPFields, userInfo: [CodingUserInfoKey : any Sendable]) throws -> D
ContentEncoder
- Instance Methods
- func encode(some Encodable, to: inout Data, headers: inout HTTPFields, userInfo: [CodingUserInfoKey : any Sendable]) throws
CredentialsAuthenticator
- Associated Types
- Credentials
- Instance Methods
- func authenticate(credentials: Credentials, for: Request) async throws
DebuggableError
Extendable
- Instance Properties
- var extend: Extend
HTTPBodyWriter
LifecycleHandler
Middleware
OptionalType
- Associated Types
- WrappedType
- Instance Properties
- var wrapped: WrappedType?
- Type Methods
- static func makeOptionalType(WrappedType?) -> Self
RequestAuthenticator
- Instance Methods
- func authenticate(request: Request) async throws
  - RequestAuthenticator Implementations
  - func authenticate(request: Request) async throws
  - func authenticate(request: Request) async throws
  - func authenticate(request: Request) async throws
  - func authenticate(request: Request) async throws
RequestBodyReader
RequestDecodable
- Type Methods
- static func decodeRequest(Request) async throws -> Self
  - RequestDecodable Implementations
  - static func decodeRequest(Request) async throws -> Self
Responder
- Instance Methods
- func respond(to: Request) async throws -> Response
ResponseEncodable
RouteCollection
- Instance Methods
- func boot(routes: any RoutesBuilder) async throws
RoutesBuilder
Server
- Instance Properties
- var listeningAddress: SocketAddress
SessionAuthenticatable
- Associated Types
- SessionID
- Instance Properties
- var sessionID: SessionID
SessionAuthenticator
- Associated Types
- User
- Instance Methods
- func authenticate(sessionID: User.SessionID, for: Request) async throws
SessionDriver
URLQueryContainer
- Instance Properties
- var contentConfiguration: ContentConfiguration
- Instance Methods
- func decode(_:)
- func decode<D>(D.Type, using: any URLQueryDecoder) throws -> D
- func encode(_:)
- func encode(some Encodable, using: any URLQueryEncoder) throws
- func get(_:at:)
- Subscripts
- subscript<D>(any CodingKeyRepresentable...) -> D?
- subscript(_:at:)
URLQueryDecoder
URLQueryEncoder
Validatable
ValidatorResult
- Instance Properties
- var failureDescription: String?
- var isFailure: Bool
- var successDescription: String?
ViewRenderer
Structures
Abort
AnyResponse
- Initializers
- init(any ResponseEncodable)
- Instance Methods
- func encodeResponse(for: Request) async throws -> Response
BaseNEncoding
- Instance Properties
- let bits: Int
- Instance Methods
- func decode(_:)
- func encode(_:)
BasicAuthorization
- Initializers
- init(username: String, password: String)
- Instance Properties
- let password: String
- let username: String
BasicResponder
- Initializers
- init(closure: @Sendable (Request) async throws -> Response)
- Instance Methods
- func respond(to: Request) async throws -> Response
BearerAuthorization
- Initializers
- init(token: String)
- Instance Properties
- let token: String
BlackholeClient
- Instance Properties
- var contentConfiguration: ContentConfiguration
- Instance Methods
- func send(ClientRequest) async throws -> ClientResponse
ByteCount
ClientRequest
- Initializers
- init(method: HTTPRequest.Method, url: URI, headers: HTTPFields, body: Body, timeout: Duration?, maxResponseBodySize: Int, contentConfiguration: ContentConfiguration)
- Instance Properties
- var body: Body
- var content: any ContentContainer
- var headers: HTTPFields
- var maxResponseBodySize: Int
- var method: HTTPRequest.Method
- var query: any URLQueryContainer
- var timeout: Duration
- var url: URI
- Type Aliases
- ClientRequest.Body
ClientResponse
ContentConfiguration
DirectoryConfiguration
- Initializers
- init(workingDirectory: String)
- Instance Properties
- var publicDirectory: String
- var resourcesDirectory: String
- var viewsDirectory: String
- var workingDirectory: String
- Type Methods
- static func detect() -> DirectoryConfiguration
DotEnvFile
Environment
ErrorSource
- Initializers
- init(file: String, function: String, line: UInt, column: UInt, range: Range<UInt>?)
- Instance Properties
- var column: UInt
- var file: String
- var function: String
- var line: UInt
- var range: Range<UInt>?
- Type Methods
- static func capture(file: String, function: String, line: UInt, column: UInt, range: Range<UInt>?) -> ErrorSource
Extend
- Initializers
- init()
- init(dictionaryLiteral: (String, Any)...)
- init(from: any Decoder) throws
- Instance Properties
- var storage: [String : Any]
- Instance Methods
- func encode(to: any Encoder) throws
- func get(_:default:)
- func set(_:to:)
- Subscripts
- subscript(String) -> Any?
File
FileIO
- Instance Methods
- func streamFile(at: String, for: Request, chunkSize: Int64, mediaType: HTTPMediaType?, advancedETagComparison: Bool, onCompleted: @Sendable (Result<Void, any Error>) async throws -> Void) async throws -> Response
HTTPCookies
HTTPMediaType
HTTPMediaTypePreference
- Instance Properties
- var mediaType: HTTPMediaType
- var q: Double?
HTTPMediaTypeSet
HTTPVersion
- Initializers
- init(major: Int, minor: Int)
- Instance Properties
- var major: Int
- var minor: Int
- Type Properties
- static var http0_9: HTTPVersion
- static var http1_0: HTTPVersion
- static var http1_1: HTTPVersion
- static var http2: HTTPVersion
- static var http3: HTTPVersion
MemorySessions
Middlewares
- Initializers
- init()
- Instance Methods
- func resolve() -> [any Middleware]
- func use(any Middleware, at: Position)
- Enumerations
- Middlewares.Position
  - Enumeration Cases
  - case beginning
  - case end
PlaintextDecoder
- Initializers
- init()
- Instance Methods
- func decode<D>(D.Type, from: Data, headers: HTTPFields, userInfo: [CodingUserInfoKey : any Sendable]) throws -> D
PlaintextEncoder
- Initializers
- init(HTTPMediaType)
- Instance Methods
- func encode(some Encodable, to: inout Data, headers: inout HTTPFields, userInfo: [CodingUserInfoKey : any Sendable]) throws
PlaintextRenderer
- Initializers
- init(viewsDirectory: String)
- Instance Methods
- func `for`(Request) -> any ViewRenderer
- func render<E>(String, E) async throws -> View
Redirect
- Instance Properties
- var status: HTTPResponse.Status
- Type Properties
- static var normal: Redirect
- static var permanent: Redirect
- static var permanentPost: Redirect
- static var temporary: Redirect
Request
RequestBodyAlreadyBeingRead
- Default Implementations
- AbortError Implementations
  - Instance Properties
  - var reason: String
  - var status: HTTPResponse.Status
RequestBodyPartiallyConsumed
- Default Implementations
- AbortError Implementations
  - Instance Properties
  - var reason: String
  - var status: HTTPResponse.Status
RequestBodyReadFailed
- Default Implementations
- AbortError Implementations
  - Instance Properties
  - var reason: String
  - var status: HTTPResponse.Status
RequestBodyTransportFailed
Response
ResponseCompressionMiddleware
- Initializers
- init(override: HTTPFields.ResponseCompression, force: Bool)
- Instance Properties
- var responseCompressionOverride: HTTPFields.ResponseCompression
- var shouldForce: Bool
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) async throws -> Response
Route
RouteNotFound
Routes
- Instance Properties
- var all: [Route]
- var caseInsensitive: Bool
- var defaultMaxBodySize: ByteCount
- var description: String
- Instance Methods
- func add(Route)
ServerConfiguration
SessionData
SessionID
SessionsConfiguration
- Initializers
- init(cookieName: String, cookieFactory: @Sendable (SessionID) -> HTTPCookies.Value)
- Instance Properties
- var cookieFactory: @Sendable (SessionID) -> HTTPCookies.Value
- var cookieName: String
- Type Methods
- static func `default`() -> SessionsConfiguration
SocketAddress
URI
URLEncodedFormDecoder
URLEncodedFormEncoder
Validation
ValidationCharacterSet
ValidationResult
Validations
ValidationsError
ValidationsResult
- Instance Properties
- var error: ValidationsError?
- let results: [ValidationResult]
- Instance Methods
- func assert() throws
Validator
ValidatorResults
View
- Initializers
- init(data: Data)
- Instance Properties
- var data: Data
- Instance Methods
- func encodeResponse(for: Request) async throws -> Response
Operators
func ! <T>(Validator<T>) -> Validator<T>
func &&(_:_:)
func + (ValidationCharacterSet, ValidationCharacterSet) -> ValidationCharacterSet
func ||(_:_:)
Type Aliases
VaporSendableMetatype
Enumerations
Base32
Base64
- Type Properties
- static let bcrypt: BaseNEncoding
- static let canonical: BaseNEncoding
- static let `default`: BaseNEncoding
BasicCodingKey
BindAddress
- Enumeration Cases
- case hostname(String, port: Int)
- case unixDomainSocket(path: String)
BodySizeLimit
CacheExpirationTime
- Enumeration Cases
- case days(Int)
- case hours(Int)
- case minutes(Int)
- case seconds(Int)
- Instance Properties
- var seconds: Int
EndpointCacheError
- Enumeration Cases
- case contentDecodeFailure(any Error)
- case unexpectedResponseStatus(HTTPResponse.Status, uri: URI)
- Type Methods
- static func unexpctedResponseStatus(HTTPResponse.Status, uri: URI) -> EndpointCacheError
HelpFormat
- Enumeration Cases
- case long
- case short
RangeResult
- Enumeration Cases
- case between(min: T, max: T)
- case greaterThanMax(T)
- case greaterThanOrEqualToMin(T)
- case lessThanMin(T)
- case lessThanOrEqualToMax(T)
ServerError
- Enumeration Cases
- case addressInUse(host: String, port: Int)
- Instance Properties
- var description: String
Extended Modules
FoundationEssentials
HTTPTypes
Logging
- Extended Structures
- Logger
  - Instance Methods
  - func report(error: any Error, level: Logger.Level?, metadata: @autoclosure () -> Logger.Metadata?, file: String, function: String, line: UInt)
MultipartKit
RoutingKit
- Extended Structures
- Parameters
  - Instance Methods
  - func require(String) throws -> String
  - func require<T>(String, as: T.Type) throws -> T
Swift

API Docs
Framework Docs

- API Docs
  
  Reference documentation for Vapor
- Framework Docs
  
  Learn how to use Vapor
Home
Store
Showcase
Team
Blog
GitHub
Theme
- Light
- Dark
- System

You're viewing documentation for a pre-release version. View the latest stable version

Type PropertyHTTPTypes

xRequestId

X-Request-Id header.

static let xRequestId: HTTPField.Name

Vapor

Reference documentation for Vapor and its ecosystem.

Community

Team
Join our Discord
Store
Showcase
Supporters

Resources

Blog
Framework Docs
API Docs
Press Kit
Help

API Documentation © 2026 Vapor.

Twitter
Mastodon
Bsky
GitHub