KituraKit

Default URL used for setting up the routes when no URL is provided in the initializer.

Default route used for setting up the paths based on the URL provided in the initializer.

Customisable URL used for setting up the routes when initializing a new KituraKit instance.

User credentials that will be used for authentication if none are provided to the route.

Usage Example:

let client = KituraKit.default
client.defaultCredentials = HTTPBasic(username: "John", password: "12345")

The BodyEncoder that will be used to encode the Codable object.

Usage Example:

let client = KituraKit.default
let encoder = JSONEncoder()
encoder.dateEncodingStrategy = .secondsSince1970
client.encoder = encoder

The BodyDecoder that will be used to decode the response Codable object.

Usage Example:

let client = KituraKit.default
let decoder = JSONDecoder()
decoder.dateDecodingStrategy = .secondsSince1970
client.decoder = decoder

The String that will be used for the Content-Type and Accept headers in the HTTP requests.

Usage Example:

let client = KituraKit.default
client.mediaType = "application/xml"

An initializer to set up a custom KituraKit instance on a specified route using a URL

An initializer to set up a custom KituraKit instance on a specified route.

Retrieves data from a designated route.

Usage Example:

struct User: Codable {
    ...
}

let client = KituraKit.default
client.get("/") { (returnedArray: [User]?, error: Error?) -> Void in
   print(returnedArray)
}

• This declaration of get retrieves all items. There is another declaration for specific item retrieval.

Retrieves data from a designated route with an Identifier.

Usage Example:

struct User: Codable {
    ...
}

let client = KituraKit.default
let idOfUserToRetrieve: Int = ...
client.get("/", identifier: idOfUserToRetrieve) { (returnedItem: User?, error: Error?) -> Void in
    print(returnedItem)
}

• This declaration of get retrieves single items. There is another declaration for all item retrieval.

Sends data to a designated route.

Usage Example:

struct User: Codable {
    ...
}

let client = KituraKit.default
let userToSend: User = ...
client.post("/", data: userToSend) { (returnedItem: User?, error: Error?) -> Void in
    print(returnedItem)
}

Sends data to a designated route, allowing for the route to respond with an additional Identifier.

Usage Example:

struct User: Codable {
    ...
}

let client = KituraKit.default
let userToSend: User = ...
client.post("/", data: userToSend) { (id: Int?, returnedItem: User?, error: Error?) -> Void in
    print("\(id): \(returnedItem)")
}

Updates data for a designated route using an Identifier.

Usage Example:

struct User: Codable {
    ...
}

let client = KituraKit.default
let idOfUserToUpdate: Int = ...
let userToSend: User = ...
client.put("/", identifier: idOfUserToUpdate, data: userToSend) { (returnedItem: User?, error: Error?) -> Void in
    print(returnedItem)
}

• This declaration uses the put method to update data.

Updates data for a designated route using an Identifier.

Usage Example:

struct User: Codable {
    let name: String
    let address: String
    ...
}
struct OptionalUser: Codable {
    let name: String?
    let address: String?
    ...
}

let client = KituraKit.default
let idOfUserToUpdate: Int = ...
let userUpdates = OptionalUser(name: "New Name", address: nil, ...)
client.patch("/", identifier: idOfUserToUpdate, data: userUpdates) { (returnedItem: User?, error: Error?) -> Void in
    print(returnedItem)
}

• This declaration uses the patch method to update data.

Deletes data at a designated route.

Usage Example:

let client = KituraKit.default
client.delete("/") { error in
    print("Successfully deleted")
}

• This declaration of delete deletes all items. There is another declaration for single item deletion.

Deletes data at a designated route using an Identifier.

Usage Example:

let client = KituraKit.default
client.delete("/", identifier: urlToSend) { error in
    print("Successfully deleted")
}

• This declaration of delete deletes single items. There is another declaration for all item deletion.

Retrieves data at a designated route using a the specified Query Parameters.

Usage Example:

struct MyQuery: QueryParams {
   let name: String
 }

let myQuery = MyQuery(name: "Michael")
let client = KituraKit.default

client.get("/users", query: myQuery) { (returnedArray: [O]?, error: Error?) -> Void in
    print("Successfully returned users with name 'Michael'")
    print(returnedArray)
}

Deletes data at a designated route using a the specified Query Parameters.

Usage Example:

struct MyQuery: QueryParams {
   let name: String
 }

let myQuery = MyQuery(name: "Michael")
let client = KituraKit.default

client.delete("/users", query: myQuery) { error in
    print("Successfully deleted users with name 'Michael'")
}

• This declaration of delete deletes multiple items. There is another declaration for a singular deletion and another for all item deletion.