Skip to content

Vapor API Docs

Vapor

Core

Vapor AsyncKit RoutingKit ConsoleKit ConsoleKitCommands ConsoleKitTerminal ConsoleLogger beta WebSocketKit MultipartKit

Authentication

JWT JWTKit Authentication

Templating

Leaf LeafKit

Database

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

Queues

Queues QueuesRedisDriver

Push Notifications

APNS

Testing

XCTVapor VaporTesting XCTFluent XCTQueues

Vapor

Classes
Application
BCryptDigest
- Initializers
- init()
- Instance Methods
- func hash(String, cost: Int) throws -> String
- func hash(String, salt: String) throws -> String
- func verify(String, created: String) throws -> Bool
BootCommand
- Structures
- BootCommand.Signature
  - Initializers
  - init()
- Initializers
- init()
- Instance Properties
- var help: String
- Instance Methods
- func run(using: CommandContext, signature: BootCommand.Signature) async throws
CORSMiddleware
EndpointCache
- Initializers
- init(uri: URI)
- Instance Methods
- func get(on: Request, logger: Logger?) -> EventLoopFuture<T>
- func get(using: any Client, logger: Logger?, on: any EventLoop) -> EventLoopFuture<T>
ErrorMiddleware
- Initializers
- init((Request, any Error) -> Response)
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) -> EventLoopFuture<Response>
- Type Methods
- static func `default`(environment: Environment) -> ErrorMiddleware
FileMiddleware
HTTPServer
Request
Response
Route
- Initializers
- init(method: HTTPMethod, path: [PathComponent], responder: any Responder, requestType: any Any.Type, responseType: any Any.Type)
- Instance Properties
- var description: String
- var method: HTTPMethod
- var path: [PathComponent]
- var requestType: any Any.Type
- var responder: any Responder
- var responseType: any Any.Type
- var userInfo: [AnySendableHashable : any Sendable]
- Instance Methods
- func description(String) -> Route
RouteLoggingMiddleware
- Initializers
- init(logLevel: Logger.Level)
- Instance Properties
- let logLevel: Logger.Level
- Instance Methods
- func respond(to: Request, chainingTo: any Responder) -> EventLoopFuture<Response>
Routes
- Initializers
- init()
- Instance Properties
- var all: [Route]
- var caseInsensitive: Bool
- var caseInsenstive: Bool
- var defaultMaxBodySize: ByteCount
- var description: String
- Instance Methods
- func add(Route)
RoutesCommand
- Structures
- RoutesCommand.Signature
  - Initializers
  - init()
- Instance Properties
- var help: String
- Instance Methods
- func run(using: CommandContext, signature: RoutesCommand.Signature) async throws
ServeCommand
- Structures
- ServeCommand.Signature
  - Initializers
  - init()
- Instance Properties
- var help: String
- let signature: ServeCommand.Signature
- Instance Methods
- func run(using: CommandContext, signature: ServeCommand.Signature) async throws
- Enumerations
- ServeCommand.Error
  - Enumeration Cases
  - case incompatibleFlags
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) -> EventLoopFuture<Response>
TracingMiddleware
- Initializers
- init()
- init(setCustomAttributes: (inout SpanAttributes, Request) -> Void)
- Instance Methods
- func respond(to: Request, chainingTo: any AsyncResponder) async throws -> Response
Protocols
AbortError
AnyOptionalType
AsyncAuthenticator
AsyncBasicAuthenticator
- Instance Methods
- func authenticate(basic: BasicAuthorization, for: Request) async throws
AsyncBearerAuthenticator
- Instance Methods
- func authenticate(bearer: BearerAuthorization, for: Request) async throws
AsyncBodyStreamWriter
AsyncCredentialsAuthenticator
- Associated Types
- Credentials
- Instance Methods
- func authenticate(credentials: Self.Credentials, for: Request) async throws
AsyncMiddleware
- Instance Methods
- func respond(to: Request, chainingTo: any AsyncResponder) async throws -> Response
  - AsyncMiddleware Implementations
AsyncRequestAuthenticator
- Instance Methods
- func authenticate(request: Request) async throws
  - AsyncRequestAuthenticator Implementations
AsyncRequestDecodable
- Type Methods
- static func decodeRequest(Request) async throws -> Self
  - AsyncRequestDecodable Implementations
    - static func decodeRequest(Request) async throws -> Self
    - static func decodeRequest(Request) -> EventLoopFuture<Self>
AsyncResponder
- Instance Methods
- func respond(to: Request) async throws -> Response
  - AsyncResponder Implementations
    - func respond(to: Request) -> EventLoopFuture<Response>
AsyncResponseEncodable
AsyncSessionAuthenticator
- Associated Types
- User
- Instance Methods
- func authenticate(sessionID: Self.User.SessionID, for: Request) async throws
AsyncSessionDriver
Authenticatable
Authenticator
BasicAuthenticator
- Instance Methods
- func authenticate(basic: BasicAuthorization, for: Request) -> EventLoopFuture<Void>
BearerAuthenticator
- Instance Methods
- func authenticate(bearer: BearerAuthorization, for: Request) -> EventLoopFuture<Void>
BodyStreamWriter
- Instance Properties
- var eventLoop: any EventLoop
- Instance Methods
- func write(BodyStreamResult) -> EventLoopFuture<Void>
- func write(BodyStreamResult, promise: EventLoopPromise<Void>?)
Cache
Client
Content
ContentContainer
- Instance Properties
- var contentType: HTTPMediaType?
- Instance Methods
- func decode(_:)
- func decode<D>(D.Type, as: HTTPMediaType) throws -> D
- func decode<D>(D.Type, using: any ContentDecoder) throws -> D
- func encode(_:)
- func encode(_:as:)
- func encode<E>(E, using: any ContentEncoder) throws
- func get(_:at:)
- Subscripts
- subscript<D>(any CodingKeyRepresentable...) -> D?
- subscript(_:at:)
ContentDecoder
ContentEncoder
CredentialsAuthenticator
- Associated Types
- Credentials
- Instance Methods
- func authenticate(credentials: Self.Credentials, for: Request) -> EventLoopFuture<Void>
DebuggableError
Extendable
- Instance Properties
- var extend: Extend
LifecycleHandler
LockKey
Middleware
OptionalType
- Associated Types
- WrappedType
- Instance Properties
- var wrapped: Self.WrappedType?
- Type Methods
- static func makeOptionalType(Self.WrappedType?) -> Self
PasswordHasher
RequestAuthenticator
- Instance Methods
- func authenticate(request: Request) -> EventLoopFuture<Void>
  - RequestAuthenticator Implementations
RequestDecodable
- Type Methods
- static func decodeRequest(Request) -> EventLoopFuture<Self>
  - AsyncRequestDecodable Implementations
    - static func decodeRequest(Request) async throws -> Self
    - static func decodeRequest(Request) -> EventLoopFuture<Self>
Responder
- Instance Methods
- func respond(to: Request) -> EventLoopFuture<Response>
  - AsyncResponder Implementations
    - func respond(to: Request) -> EventLoopFuture<Response>
ResponseEncodable
RouteCollection
- Instance Methods
- func boot(routes: any RoutesBuilder) throws
RoutesBuilder
Server
SessionAuthenticatable
- Associated Types
- SessionID
- Instance Properties
- var sessionID: Self.SessionID
SessionAuthenticator
- Associated Types
- User
- Instance Methods
- func authenticate(sessionID: Self.User.SessionID, for: Request) -> EventLoopFuture<Void>
SessionDriver
StorageKey
- Associated Types
- Value
URLQueryContainer
- Instance Methods
- func decode(_:)
- func decode<D>(D.Type, using: any URLQueryDecoder) throws -> D
- func encode(_:)
- func encode<E>(E, using: any URLQueryEncoder) throws
- func get(_:at:)
- Subscripts
- subscript<D>(any CodingKeyRepresentable...) -> D?
- subscript(_:at:)
URLQueryDecoder
URLQueryEncoder
Upgrader
- Instance Methods
- func applyUpgrade(req: Request, res: Response) -> any HTTPServerProtocolUpgrader
Validatable
ValidatorResult
- Instance Properties
- var failureDescription: String?
- var isFailure: Bool
- var successDescription: String?
ViewRenderer
Structures
Abort
AnyAsyncResponse
- Initializers
- init(any AsyncResponseEncodable)
- Instance Methods
- func encodeResponse(for: Request) async throws -> Response
AnyResponse
- Initializers
- init(any ResponseEncodable)
- Instance Methods
- func encodeResponse(for: Request) -> EventLoopFuture<Response>
AsyncBasicResponder
- Initializers
- init(closure: (Request) async throws -> Response)
- Instance Methods
- func respond(to: Request) async throws -> Response
AsyncPasswordHasher
- Initializers
- init(hasher: any PasswordHasher, threadPool: NIOThreadPool, eventLoop: any EventLoop)
- Instance Methods
- func hash(_:)
- func verify(_:created:)
BaseNEncoding
- Instance Properties
- let bits: Int
- Instance Methods
- func decode<C>(C) -> [UInt8]?
- func encode<C>(C) -> [UInt8]
BasicAuthorization
- Initializers
- init(username: String, password: String)
- Instance Properties
- let password: String
- let username: String
BasicResponder
- Initializers
- init(closure: (Request) throws -> EventLoopFuture<Response>)
- Instance Methods
- func respond(to: Request) -> EventLoopFuture<Response>
BearerAuthorization
- Initializers
- init(token: String)
- Instance Properties
- let token: String
ByteCount
ClientRequest
ClientResponse
ContentConfiguration
DecoderUnwrapper
- Initializers
- init(from: any Decoder)
- Instance Properties
- let decoder: any Decoder
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
HOTP
- Initializers
- init(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits)
- Instance Methods
- func generate(counter: UInt64) -> String
- func generate(counter: UInt64, range: Int) -> [String]
- Type Methods
- static func generate(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits, counter: UInt64) -> String
HTTPCookies
HTTPMediaType
HTTPMediaTypePreference
- Instance Properties
- var mediaType: HTTPMediaType
- var q: Double?
HTTPMediaTypeSet
MemorySessions
Middlewares
- Initializers
- init()
- Instance Methods
- func resolve() -> [any Middleware]
- func use(any Middleware, at: Middlewares.Position)
- Enumerations
- Middlewares.Position
  - Enumeration Cases
  - case beginning
  - case end
PlaintextDecoder
- Initializers
- init()
- Instance Methods
- func decode<D>(D.Type, from: ByteBuffer, headers: HTTPHeaders) throws -> D
- func decode<D>(D.Type, from: ByteBuffer, headers: HTTPHeaders, userInfo: [CodingUserInfoKey : any Sendable]) throws -> D
PlaintextEncoder
PlaintextRenderer
- Initializers
- init(fileio: NonBlockingFileIO, viewsDirectory: String, logger: Logger, eventLoopGroup: any EventLoopGroup)
- Instance Properties
- let eventLoopGroup: any EventLoopGroup
- Instance Methods
- func `for`(Request) -> any ViewRenderer
- func render<E>(String, E) -> EventLoopFuture<View>
Redirect
- Instance Properties
- var status: HTTPStatus
- Type Properties
- static var normal: Redirect
- static var permanent: Redirect
- static var permanentPost: Redirect
- static var temporary: Redirect
ResponseCompressionMiddleware
- Initializers
- init(override: HTTPHeaders.ResponseCompression, force: Bool)
- Instance Properties
- var responseCompressionOverride: HTTPHeaders.ResponseCompression
- var shouldForce: Bool
- Instance Methods
- func respond(to: Request, chainingTo: any AsyncResponder) async throws -> Response
RouteNotFound
SessionData
SessionID
SessionsConfiguration
- Initializers
- init(cookieName: String, cookieFactory: (SessionID) -> HTTPCookies.Value)
- Instance Properties
- var cookieFactory: (SessionID) -> HTTPCookies.Value
- var cookieName: String
- Type Methods
- static func `default`() -> SessionsConfiguration
StackTrace
Storage
TOTP
- Initializers
- init(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits, interval: Int)
- Instance Methods
- func generate(time: Date) -> String
- func generate(time: Date, range: Int) -> [String]
- Type Methods
- static func generate(key: SymmetricKey, digest: OTPDigest, digits: OTPDigits, interval: Int, time: Date) -> String
URI
URLEncodedFormDecoder
URLEncodedFormEncoder
Validation
ValidationResult
Validations
ValidationsError
ValidationsResult
- Instance Properties
- var error: ValidationsError?
- let results: [ValidationResult]
- Instance Methods
- func assert() throws
Validator
ValidatorResults
View
WebSocketMaxFrameSize
- Initializers
- init(integerLiteral: Int)
- Type Properties
- static var `default`: WebSocketMaxFrameSize
WebSocketUpgrader
Variables
var Bcrypt: BCryptDigest
Operators
func ! <T>(Validator<T>) -> Validator<T>
func &&(_:_:)
func + (CharacterSet, CharacterSet) -> CharacterSet
func ?? <T>(EventLoopFuture<T?>, T) -> EventLoopFuture<T>
func ||(_:_:)
Type Aliases
CodingKeyRepresentable
HTTPStatus
ValidationKey
VaporSendableMetatype
Enumerations
Base32
Base64
- Type Properties
- static let bcrypt: BaseNEncoding
- static let canonical: BaseNEncoding
- static let `default`: BaseNEncoding
BasicCodingKey
BcryptError
- Enumeration Cases
- case hashFailure
- case invalidCost
- case invalidHash
- case invalidSalt
- Instance Properties
- var description: String
- var errorDescription: String?
BindAddress
- Enumeration Cases
- case hostname(String?, port: Int?)
- case unixDomainSocket(path: String)
BodyStreamResult
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 unexpctedResponseStatus(HTTPStatus, uri: URI)
HTTPBodyStreamStrategy
- Enumeration Cases
- case collect(maxSize: ByteCount?)
- case stream
- Type Properties
- static var collect: HTTPBodyStreamStrategy
HTTPVersionMajor
- Enumeration Cases
- case one
- case two
HelpFormat
- Enumeration Cases
- case long
- case short
OTPDigest
- Enumeration Cases
- case sha1
- case sha256
- case sha512
OTPDigits
- Enumeration Cases
- case eight
- case seven
- case six
- Initializers
- init?(rawValue: Int)
RangeResult
- Enumeration Cases
- case between(min: T, max: T)
- case greaterThanMax(T)
- case greaterThanOrEqualToMin(T)
- case lessThanMin(T)
- case lessThanOrEqualToMax(T)
RedirectType
- Enumeration Cases
- case normal
- case permanent
- case temporary
- Instance Properties
- var status: HTTPStatus
Extended Modules
ConsoleKitCommands
- Extended Structures
- CommandContext
  - Instance Properties
  - var application: Application
Foundation
- Extended Classes
- Thread
  - Type Methods
  - static func async(() -> ())
FoundationEssentials
Logging
MultipartKit
NIOCore
NIOHTTP1
RoutingKit
- Extended Structures
- Parameters
  - Instance Methods
  - func require(String) throws -> String
  - func require<T>(String, as: T.Type) throws -> T
Swift
WebSocketKit
- Extended Classes
- WebSocket

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

Instance PropertySwift

wrapped

See OptionalType.wrapped

var wrapped: Wrapped? { get }

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

Twitter
Mastodon
Bsky
GitHub