Javier Cicchelli
6e785b4255
This PR contains the work done to set the [European Union Public License](https://joinup.ec.europa.eu/collection/eupl/introduction-eupl-licence) license for this library, which also implies to update the header of the existing source code to reflect this license. Furthermore, a hand-drawn logo for this library has been included. Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Reviewed-on: #6
36 lines
1.5 KiB
Swift
36 lines
1.5 KiB
Swift
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This source file is part of the SwiftLibs open source project
|
|
//
|
|
// Copyright (c) 2023 Röck+Cöde VoF. and the SwiftLibs project authors
|
|
// Licensed under the EUPL 1.2 or later.
|
|
//
|
|
// See LICENSE.txt for license information
|
|
// See CONTRIBUTORS.txt for the list of SwiftLibs project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
import Foundation
|
|
|
|
/// This protocol defines a client that will be making the remote calls.
|
|
public protocol Client {
|
|
|
|
// MARK: Functions
|
|
|
|
/// Makes a request to a remote location based on a given endpoint and expects to return a response casted as a given model type.
|
|
/// - Parameters:
|
|
/// - endpoint: The endpoint for which to make a remote call.
|
|
/// - model: The model to cast an expected response from the remote location.
|
|
/// - Returns: A casted model instance created out of a response retrieved from a call to a remote endpoint.
|
|
func request<Model: Decodable>(
|
|
endpoint: some Endpoint,
|
|
as model: Model.Type
|
|
) async throws -> Model
|
|
|
|
/// Makes a request to a remote location based on a given endpoint and expects to return an original, uncasted response.
|
|
/// - Parameter endpoint: The endpoint for which to make a remote call.
|
|
/// - Returns: An original data response from a call to a remote endpoint.
|
|
@discardableResult func request(endpoint: some Endpoint) async throws -> Data
|
|
|
|
}
|