A swift request & response framework for JSON apis.
This package has been designed to work across multiple swift environments by utilizing conditional checks. It has been tested on Apple platforms (macOS, iOS, tvOS, watchOS), as well as Linux (Ubuntu).
SessionPlus is distributed using the Swift Package Manager.
You can add it using Xcode or by listing it as a dependency in your Package.swift
manifest:
let package = Package(
...
dependencies: [
.package(url: "https://github.com/richardpiazza/SessionPlus.git", .upToNextMajor(from: "2.0.0")
],
...
targets: [
.target(
name: "MyPackage",
dependnecies: [
"SessionPlus"
]
)
]
)
SessionPlus offers a default implementation (URLSessionClient
) that allows for requesting data from a JSON api. For example:
let url = URL(string: "https://api.agify.io")!
let client = BaseURLSessionClient(baseURL: url)
let request = Get(queryItems: [URLQueryItem(name: "name", value: "bob")])
let response = try await client.request(request)
The Client
protocol also offers extensions for automatically decoding responses to any Decodable
type.
struct ApiResult: Decodable {
let name: String
let age: Int
let count: Int
}
let response = try await client.request(request) as ApiResult
...
let response: ApiResult = try await client.request(request)
The Client
protocol declares up to three forms requests based on platform abilities:
// async/await for swift 5.5+
func performRequest(_ request: Request) async throws -> Response
// completion handler for backwards compatibility
func performRequest(_ request: Request, completion: @escaping (Result<Response, Error>) -> Void)
// Combine publisher that emits with a response
func performRequest(_ request: Request) -> AnyPublisher<Response, Error>
Contributions to SessionPlus are welcomed and encouraged! See the Contribution Guide for more information.