CleanNetwork

CleanNetwork is a lightweight URLSession wrapper for using async/await in networking. You can use CleanNetwork for creating a modular network layer in projects. CleanNetwork is best way to combine asnc/await with networking. Feel free to contribute :)

Table of contents

• CleanNetwork
• Table of contents
  • Swift Style Guide
  • Installation
    • Swift Package Manager
  • Simple Usage
    • Creating CLEndpoint
    • Creating Request Object
    • Sending Request
  • Advance Usage
    • Requests
    • Customize CLNetworkService
      • CLNetworkConfig
    • Error Handling

Swift Style Guide

This project uses Swift API and Raywenderlich guideline. Please check it out before contributing.

• The Swift API Design Guidelines
• The Raywenderlich Swift Style Guide

Installation

Swift Package Manager

Once you have your Swift package set up, adding CleanNetwork as a dependency is as easy as adding it to the dependencies value of your Package.swift.

dependencies: [
    .package(url: "https://github.com/alperen23230/CleanNetwork", .upToNextMajor(from: "1.1.0"))
]

Simple Usage

Firstly you have to create a request object for sending request. You can use CLNetworkDecodableRequest type for this.

struct ExampleRequest: CLNetworkDecodableRequest {
    typealias ResponseType = ExampleDecodableModel

    let endpoint: CLEndpoint
    let method: CLHTTPMethod
    
    init(endpoint: CLEndpoint, method: CLHTTPMethod) {
        self.endpoint = endpoint
        self.method = method
    }
}

Creating CLEndpoint

CLEndpoint is a struct which represents an API endpoint. It has a baseURL, path and queryItems variables. For baseURL, there is a static variable inside the CLURLComponent enum. It's called CLURLComponent.baseURL. (For example you can set CLURLComponent.baseURL in AppDelegate) For url scheme, it uses https by default but you can change using urlScheme static variable inside the CLURLComponent.

public struct CLEndpoint {
    public var baseURL: String
    public var path: String
    public var queryItems: [URLQueryItem]
    
    public init(baseURL: String = CLURLComponent.baseURL,
                path: String,
                queryItems: [URLQueryItem] = []) {
        self.baseURL = baseURL
        self.path = path
        self.queryItems = queryItems
    }
}

Creating Request Object

let endpoint = CLEndpoint(path: "/example")
let method: CLHTTPMethod = .get
let exampleRequest = ExampleRequest(endpoint: endpoint, method: method) 

Sending Request

You have to use CLNetworkService for sending request. You can use both shared object or creating object. Use fetch method of network service object.

do {
    let response = try await CLNetworkService.shared.fetch(exampleRequest)
    await MainActor.run {
        // Switch to main thread
    }
} catch {
    // Handle error here
}

Advance Usage

Requests

There are 3 request protocol.

CLNetworkRequest is the basic protocol. It's for fetching raw Data. By default method is GET and headers are empty.

public protocol CLNetworkRequest {
    var endpoint: CLEndpoint { get }
    var method: CLHTTPMethod { get }
    var headers: [String: String] { get }
}

CLNetworkDecodableRequest is for fetching decodable response. You have to specify response type in your request. It has to be Decodable.

public protocol CLNetworkDecodableRequest: CLNetworkRequest {
    associatedtype ResponseType: Decodable
    
    var endpoint: CLEndpoint { get }
    var method: CLHTTPMethod { get }
    var headers: [String: String] { get }
}

CLNetworkBodyRequest is for sending body request. You have to specify body type in your request. It has to be Encodable. By default method is POST.

public protocol CLNetworkBodyRequest: CLNetworkDecodableRequest {
    associatedtype RequestBodyType: Encodable
    
    var requestBody: RequestBodyType { get }
}

Customize CLNetworkService

When you want to customize the CLNetworkService you have to use the NetworkConfig instance inside the CLNetworkService. By default it uses instance of CLNetworkConfig.

public var config: NetworkConfig = CLNetworkConfig()

CLNetworkConfig

You can change the configuration using CLNetworkConfig instance.

public class CLNetworkConfig: NetworkConfig {
    public var decoder = JSONDecoder()
    public var encoder = JSONEncoder()
    public var urlSession = URLSession.shared
    public var loggerEnabled = true
    public var sharedHeaders: [String: String] = [:]

    public init() {}
}

Error Handling

There is an error enum for unique errors. It's called CLError.

public enum CLError: Error {
    case errorMessage(CLErrorMessage)
    /// APIError response data, HTTP status code
    case apiError(Data, Int?)
}

The enum has a 2 case. The first case, errorMessage case is for handling known errors. (For example data returning nil.)

The second case, apiError case is for handling API error json models. This case is an associated value case. It's returning the data which will decode. Also returns the HTTP status code to handle some situations.