RoutesBuilder extension to make it easy to return response status along with Content DTOs

RoutesBuilderExtension.swift

import Vapor




/**
	Convenience extensions to allow writing route handlers that return a tuple
	of `(HTTPStatus, Content)`, so it’s easier to control the response status.
*/

extension
RoutesBuilder
{
    @discardableResult
    public func get<Response>(
        _ path: PathComponent...,
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.GET, path, use: closure)
    }

    @discardableResult
    public func get<Response>(
        _ path: [PathComponent],
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.GET, path, use: closure)
    }

    @discardableResult
    public func post<Response>(
        _ path: PathComponent...,
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.POST, path, use: closure)
    }

    @discardableResult
    public func post<Response>(
        _ path: [PathComponent],
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.POST, path, use: closure)
    }

    @discardableResult
    public func patch<Response>(
        _ path: PathComponent...,
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.PATCH, path, use: closure)
    }

    @discardableResult
    public func patch<Response>(
        _ path: [PathComponent],
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.PATCH, path, use: closure)
    }

    @discardableResult
    public func put<Response>(
        _ path: PathComponent...,
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.PUT, path, use: closure)
    }

    @discardableResult
    public func put<Response>(
        _ path: [PathComponent],
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.PUT, path, use: closure)
    }

    @discardableResult
    public func delete<Response>(
        _ path: PathComponent...,
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.DELETE, path, use: closure)
    }

    @discardableResult
    public func delete<Response>(
        _ path: [PathComponent],
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
        return self.on(.DELETE, path, use: closure)
    }

    @discardableResult
    public func on<Response>(
        _ method: HTTPMethod,
        _ path: [PathComponent],
        body: HTTPBodyStreamStrategy = .collect,
        use closure: @escaping (Request) async throws -> (HTTPStatus, Response)
    ) -> Route
        where Response: AsyncResponseEncodable
    {
    	return self.on(method, path, body: body)
    	{ inReq in
        	let (s, r) = try await closure(inReq)
        	return try await r.encodeResponse(status: s, for: inReq)
    	}
    }
}