[Improvement] Naming of libraries and package (#22)
This PR contains the work done to fix the naming of the libraries and the package, along with tweaks to the folder structure. Reviewed-on: #22 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
This commit was merged in pull request #22.
This commit is contained in:
@@ -0,0 +1,30 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// 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
|
||||
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
//===----------------------------------------------------------------------===//
|
||||
//
|
||||
// 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 an endpoint to be used in a remote call.
|
||||
public protocol Endpoint {
|
||||
|
||||
// MARK: Type aliases
|
||||
|
||||
typealias Parameters = [String : String?]
|
||||
typealias Headers = [String : String]
|
||||
|
||||
// MARK: Properties
|
||||
|
||||
/// The scheme subcomponent for the endpoint.
|
||||
var scheme: String { get }
|
||||
|
||||
/// The host subcomponent for the endpoint.
|
||||
var host: String { get }
|
||||
|
||||
/// The port subcomponent for the component.
|
||||
var port: Int? { get }
|
||||
|
||||
/// The path subcomponent for the endpoint.
|
||||
var path: String { get }
|
||||
|
||||
/// The query parameter subcomponents for the endpoint.
|
||||
var parameters: Parameters { get }
|
||||
|
||||
/// The HTTP request method for the endpoint.
|
||||
var method: HTTPRequestMethod { get }
|
||||
|
||||
/// The HTTP header fields as a dictionary for the endpoint.
|
||||
var headers: Headers { get }
|
||||
|
||||
/// The message body as data for a request.
|
||||
var body: Data? { get }
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user