Swiftpack.co - Package - thejohnlima/BaseNetworkKit

BaseNetworkKit

GitHub release Build Status CocoaPods GitHub repo size License Platform Donate

BaseNetworkKit is the easiest way to create your network layer in Swift.

❗️Requirements

  • iOS 9.3+
  • Swift 5.0+

βš’ Installation

Swift Package Manager

BaseNetworkKit is available through SPM. To install it, follow the steps:

Open Xcode project > File > Swift Packages > Add Package Dependecy

After that, put the url in the field: https://github.com/thejohnlima/BaseNetworkKit.git

CocoaPods

BaseNetworkKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'BaseNetworkKit'

and run pod install

πŸŽ“ How to use

Import library in your network layer:

import BaseNetworkKit

Setup request

enum RequesterAPI {
  // Body can be a model object conform to NKCodable
  case listOfItems(Body)
}

extension RequesterAPI: NKFlowTarget {
  // Set your api
  var baseURL: URL {
    return URL(stringValue: "https://your.api")
  }

  // Set your endpoints
  var path: String {
    switch self {
    case .listOfItems:
      return "endpoint1"
    }
  }

  // Set http methods
  var method: NKHTTPMethods {
    return .get
  }

  // Set headers if needed
  var headers: NKCommon.HTTPHeader? {
    return [
      "key1": "value2",
      "key2": "value2"
    ]
  }

  // Here you can set the tasks, like parameters
  var task: NKTask {
    switch self {
    case .listOfItems(let body):
      guard let params = body.dictionary(), !params.isEmpty else {
        return .requestPlain
      }
      return .requestParameters(params, encoding: .queryString)
    }
  }

  // You want to see the request logs, set the environment to develop
  var environment: NKEnvironment {
    return .develop
  }
}

Than, create a request function

class Service: NKBaseService<RequesterAPI> {
  func fetchItems(page: Int, limit: Int, completion: @escaping NKCommon.ResultType<Model>) {
    let requestModel = ModelRequest(offset: "\(page)", limit: "\(limit)")
    fetch(.listOfItems(requestModel), dataType: Model.self, completion: completion)
  }
}

If you need more examples, open demo project.

πŸ™‹πŸ»β€ Communication

  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, submit a pull request. πŸ‘¨πŸ»β€πŸ’»

πŸ“œ License

BaseNetworkKit is under MIT license. See the LICENSE file for more info.

Github

link
Stars: 0

Dependencies

Used By

Total: 0

Releases

Version 1.1.2 - 2019-12-23 19:31:39

  • Update dependencies;
  • Add Github actions;

Version 1.1.1 - 2019-08-30 04:25:11

  • Improve code style;

Version 1.1.0 - 2019-08-30 03:18:22

  • Fix access modifiers;

Version 1.0.9 - 2019-08-23 12:47:12

  • Add support for swift package manager;

Version 1.0.8 - 2019-06-22 15:50:39

  • Improve http body request

Version 1.0.7 - 2019-05-29 00:38:52

  • Fix error validation in request result data;

Version 1.0.6 - 2019-05-02 03:39:05

Improve requests using new Swift 5 Result Type

  • Update CI configuration file;
  • Update README file;
  • Start using new Swift 5 result type in requests completion block;
  • Update demo project;

Version 1.0.5 - 2019-04-18 02:34:27

β€’ Improve debug prints; β€’ Add result data for CompletionHandlerPlain block;

Version 1.0.4 - 2019-03-27 02:09:10

  • Set path and headers for optional in NKFlowTarget;
  • Set ValidationStatus to public;
  • Improve baseURL;
  • Update demo project;
  • Set new version;
  • Update README;

Version 1.0.3 - 2019-03-15 03:37:21

Version 1.0.2 - 2019-03-08 03:35:39

Add initializer for base service

Version 1.0.0 - 2019-03-08 03:03:30

First version

Version 1.0.1 - 2019-03-08 03:02:18

Fix access modifier