Builder Class Reference


                    
                    
                    routes

An instance of RouteCollection.

Declaration

Swift

public var routes: RouteCollection


                    
                    
                    init(_:)

Initializes a new instance with another RouteCollection.

Declaration

Swift

public init(_ routes: RouteCollection = .init())

Parameters


                                routes

An instance of RouteCollection.


                    
                    
                    delete(_:name:middleware:handler:)

Creates a new instance of Route with a DELETE HTTP request method.

Declaration

Swift

@discardableResult
public func delete(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    get(_:name:middleware:handler:)

Creates a new instance of Route with a GET HTTP request method.

Declaration

Swift

@discardableResult
public func get(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    head(_:name:middleware:handler:)

Creates a new instance of Route with a HEAD HTTP request method.

Declaration

Swift

@discardableResult
public func head(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    options(_:name:middleware:handler:)

Creates a new instance of Route with a OPTIONS HTTP request method.

Declaration

Swift

@discardableResult
public func options(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    patch(_:name:middleware:handler:)

Creates a new instance of Route with a PATCH HTTP request method.

Declaration

Swift

@discardableResult
public func patch(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    post(_:name:middleware:handler:)

Creates a new instance of Route with a POST HTTP request method.

Declaration

Swift

@discardableResult
public func post(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    put(_:name:middleware:handler:)

Creates a new instance of Route with a PUT HTTP request method.

Declaration

Swift

@discardableResult
public func put(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> Route?

Parameters

`path`	A path to a resource. Defaults to `/`.
`name`	A unique name for `Route`. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

A new instance of Route.


                    
                    
                    request(_:methods:middleware:handler:)

Creates an array with one or more instances of Route based on HTTP request methods provided.

Declaration

Swift

@discardableResult
public func request(
    _ path: String = Route.defaultPath,
    methods: Set<Request.Method> = Set(Request.Method.allCases),
    middleware: [Middleware] = .init(),
    handler: @escaping Route.Handler
) -> [Route]

Parameters

`path`	A path to a resource. Defaults to `/`.
`methods`	An array of HTTP request methods. Defaults to all supported HTTP request methods.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler to call.

Return Value

An array with one or more instances of Route.


                    
                    
                    grouped(_:name:middleware:)

Creates a new child instance/node of Builder with RouteCollection.

Declaration

Swift

public func grouped(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init()
) -> Builder?

Parameters

`path`	A path prefix to a resource. Defaults to `/`.
`name`	A name prefix for `Route`s. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.

Return Value

A new child instance/node of Builder.


                    
                    
                    group(_:name:middleware:handler:)

Creates a new child instance/node of Builder with RouteCollection.

Declaration

Swift

public func group(
    _ path: String = Route.defaultPath,
    name: String = "",
    middleware: [Middleware] = .init(),
    handler: @escaping (Builder) -> Void
)

Parameters

`path`	A path prefix to a resource. Defaults to `/`.
`name`	A name prefix for `Route`s. Defaults to an empty string.
`middleware`	An array of registered `Middleware`. Defaults to an empty array.
`handler`	A handler with a new child instance/node of `Builder` .