RestKit for Watson Developer Cloud Swift SDK

Overview

RestKit is a dependency used in the IBM Watson Swift SDK. It provides the networking layer used by the Swift SDK to communicate between your iOS app and Watson services. For more information on IBM Watson services, visit the IBM Watson homepage.

Requirements

• Xcode 9.3+
• Swift 4.2+
• iOS 10.0+

Installation

RestKit can be installed with Cocoapods, Carthage, or Swift Package Manager.

Cocoapods

You can install Cocoapods with RubyGems:

$ sudo gem install cocoapods

If your project does not yet have a Podfile, use the pod init command in the root directory of your project. To install RestKit using Cocoapods, add the following to your Podfile (substituting MyApp with the name of your app).

use_frameworks!

target 'MyApp' do
    pod 'IBMWatsonRestKit', '~> 3.0.3'
end

Then run the pod install command, and open the generated .xcworkspace file. To update to a newer release of RestKit, use pod update RestKit.

For more information on using Cocoapods, refer to the Cocoapods Guides.

Carthage

You can install Carthage with Homebrew:

$ brew update
$ brew install carthage

If your project does not have a Cartfile yet, use the touch Cartfile command in the root directory of your project. To install RestKit using Carthage, add the following to your Cartfile.

github "watson-developer-cloud/restkit" ~> 3.0.3

Then run the following command to build the dependencies and frameworks:

$ carthage update --platform iOS

Follow the remaining Carthage installation instructions here. Make sure to drag-and-drop the built RestKit.framework into your Xcode project and import it in the source files that require it.

Swift Package Manager

Add the following to your Package.swift file to identify RestKit as a dependency. The package manager will clone RestKit when you build your project with swift build.

dependencies: [
    .package(url: "https://github.com/watson-developer-cloud/restkit", from: "3.0.3")
]

Contributing

We would love any and all help! If you would like to contribute, please read our CONTRIBUTING documentation with information on getting started.

License

This library is licensed under Apache 2.0. Full license text is available in LICENSE.

This SDK is intended for use with an Apple iOS product and intended to be used in conjunction with officially licensed Apple development tools.