Code Monkey home page Code Monkey logo

apiclient's Introduction

CI Swift Platforms

README.md

# APIClient

## Description
A simply networking layer in Swift that allows you to easily make HTTP requests and handle response data.

## Installation
To use the APIClient module in your Swift project, include this package as a dependency in your Package.swift file.

```swift
dependencies: [
    .package(url: "https://github.com/doxuto/APIClient.git", from: "1.0.0")
]

Usage

  1. Import the APIClient module in your Swift files where you need to make API requests.
import APIClient

struct UserEndpoint: Endpoint {
    var url: URL = URL(string: "https://httpbin.org/get")!
    var requestMethod: RequestMethod = RequestMethod.get
    var headers: [String : String]? = nil
    var parameters: [String : String]? = nil
    var timeoutInterval: TimeInterval = 60
}

let apiClient = APIClient(
            validator: DefaultValidator(),
            urlSession: URLSession.shared,
            jsonDecoder: JSONDecoder()
)
        
let endpoint = UserEndpoint()
let user: User = try await apiClient.request(endpoint: endpoint)

Or you can use Combine's Publisher type to handle API responses.

 func fetchUser() -> AnyPublisher<User, Error> {
    let endpoint = UserEndpoint()
    return apiClient.request(endpoint: endpoint)
 }
    
  1. If you want to customize the Validator of APIClient, you can do that in the contructor APIClient
struct CustomizedValidator: Validator {
    func validate(for response: HTTPURLResponse) throw -> Bool {
        let statusCode = response.statusCode
        return statusCode == 200
    }
}

let apiClient = APIClient(
            validator: CustomizedValidator(),
            urlSession: URLSession.shared,
            jsonDecoder: JSONDecoder()
)
        
let endpoint = UserEndpoint()
let user: User = try await apiClient.request(endpoint: endpoint)

Dependencies

  • No external dependencies required.

Structure

  • APIClient: Main module for handling API requests.
  • APIClientTests: Unit tests for the APIClient module.

Contribution

Feel free to contribute by forking the repository and submitting pull requests.

License

This package is released under the MIT License. See LICENSE file for more details.

apiclient's People

Contributors

doxuto avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.