Skip to content

Latest commit

 

History

History
executable file
·
142 lines (123 loc) · 5.7 KB

README.md

File metadata and controls

executable file
·
142 lines (123 loc) · 5.7 KB
Raw

iOS SDK for work with AyanTech web services

use this SDK for communicate with AyanTech web services.

Installation:

In your project PodFile add this line:

pod 'AyanTechNetworkingLibrary`

And then run pod install command from terminal

Usage:

//method can be omitted (default is POST)
let request = ATRequest.request(url: "https://ayantech.ir/some/endpoint/url", method: .post)
request.setJsonBody(body: [
    "Parameters": [
        "ParamA": "ValueA",
        "ParamB": "ValueB"
    ]
])
request.send { response in
    print("response code is: \(response.responseCode)")
    print("response raw string is: \(response.responseString)")
    print("response raw json is: \(response.responseJsonObject)")
    print("parameters json object is: \(response.parametersJsonObject)")
}

Mocking response:

Good news 😍! you can mock your response using a response file.

Response file is a json file containing response body and headers. Currently only success responses can be mocked. here is the mock json file format and usage:

Mock file format:

{
  "headers": {},
  "body": {},
  "meta": {
    "statusCode": 200,
    "delay": 2.0
  }
}
  • header should be Object containing all header fields. (optional)
  • meta should be Object contains the status code and response delay in second. meta object is optional, default value for statusCode is 200 and for delay is 0
  • body can be any type i.e. Object, Array, String, Int, ... (required)

example of mock json file:

{
  "headers": {
    "Access-Control-Allow-Headers": "X-Requested-With,Content-Type, Accept",
    "Access-Control-Allow-Origin": "*",
    "Cache-Control": "private",
    "Content-Length": "805",
    "Content-Type": "application/json; charset=utf-8",
    "Date": "Wed, 12 Sep 2018 06:05:07 GMT",
    "Server": "Microsoft-IIS/8.5",
    "X-AspNet-Version": "4.0.30319",
    "X-Powered-By": "ASP.NET"
  },
  "body": {
    "Parameters": [
      {
        "Detail": "درخواست انتقال وجه",
        "ID": 100,
        "Name": "100",
        "ShowName": "100"
      }
    ],
    "Status": {
      "Code": "G00000",
      "Description": "درخواست با موفقیت انجام شد."
    }
  },
  "meta": {
    "statusCode": 200,
    "delay": 2.0
  }
}

Using mock file to mock response:

Just use mockResponse method of ATRequest and pass the file path.
It looks like this:

ATRequest.request(url: "http://api.ayantech.ir/sampleApi", method: .get)
    .mockResponse(using:  Bundle.main.path(forResource: "mockFile", ofType: nil)!)
    .send { response in
        print(response.responseString ?? "null")
    }

Cheatsheet:

ATRequest:

Property Type Description
url String Request url string
method HTTPMethod Request http method (get, post, put, ...)
headers [String: String] Request headers
body [String: Any] Request parameters (can be body or query params depend on encoding)
encoding ParameterEncoding Encoding method for body. this variable decides whether body should be query parameters os http body

ATResponse:

Property Type Description
headers [AnyHashable: Any] Response headers map
responseString String? Response raw body in String
status Status? Response Status object (if exist)
error ATError? Response error (if status code is something other than 20x)
responseCode Int Response status code (20x for success)
responseJsonObject [String: Any]? Response body in JSON object format (if body is a valid json string)
parametersJsonObject [String Any]? Parameters object of response json object (if exist)

ATError

Property Type Description
persianDescription String? Error human-readable string in Farsi
code Int? Error code
type ATErrorType? Error type
name String? Error code name

ATErrorType

Case Description
noInternet When the user has no internet connection (neither wifi nor cellular)
timeout When the request has timed out
serverError When server returns 50x error code
cancelled When request was cancelled by user
general None of the above