OHHTTPStubs
is a library designed to stub your network requests very easily. It can help you:
It works with NSURLConnection
, NSURLSession
, AFNetworking
, Alamofire
or any networking framework that use Cocoa's URL Loading System.
OHHTTPStubs
headers are fully documented using Appledoc-like / Headerdoc-like comments in the header files. You can also read the online documentation here.
OHHTTPStubs
.Instead of writing the content of the stubs you want to use manually, you can use tools like SWHttpTrafficRecorder to record network requests into files. This way you can later use those files as stub responses.
This tool can record all three formats that are supported by OHHTTPStubs
(the HTTPMessage
format, the simple response boby/content file, and the Mocktail
format).
(There are also other ways to perform a similar task, including using curl -is <url> >foo.response
to generate files compatible with the HTTPMessage
format, or using other network recording libraries similar to SWHttpTrafficRecorder
).
OHHTTPStubs
is compatible with iOS5+, OS X 10.7+, tvOS.OHHTTPStubs
also works with NSURLSession
as well as any network library wrapping them.OHHTTPStubs
is fully compatible with Swift 3.x, 4.x and Swift 5.x.Nullability annotations have also been added to the ObjC API to allow a cleaner API when used from Swift even if you don't use the dedicated Swift API wrapper provided by OHHTTPStubsSwift.swift
.
Using CocoaPods is the recommended way.
OHHTTPStubs
from Objective-C only, add pod 'OHHTTPStubs'
to your Podfile
.OHHTTPStubs
from Swift, add pod 'OHHTTPStubs/Swift'
to your Podfile
instead.pod 'OHHTTPStubs/Swift' # includes the Default subspec, with support for NSURLSession & JSON, and the Swiftier API wrappers
OHHTTPStubs
is split into subspecs so that when using Cocoapods, you can get only what you need, no more, no less.
NSURLSession
, JSON
, and OHPathHelpers
Swift
subspec adds the Swiftier API to that default subspecHTTPMessage
and Mocktail
are opt-in subspecs: list them explicitly if you need themOHPathHelpers
doesn't depend on Core
and can be used independently of OHHTTPStubs
altogetherOHHTTPStubs
is compatible with Swift Package Manager, and provides 2 targets for consumption: OHHTTPStubs
and OHHTTPStubsSwift
.
OHHTTPStubs
is equivalent to the OHHTTPStubs
subspec.OHHTTPStubsSwift
is equivalent to the OHHTTPStubs/Swift
subspec.Note: We currently do not have support for the HTTPMessage or Mocktail subspecs in Swift Package Manager. If you are interested in these, please open an issue to explain your needs.
OHHTTPStubs
is also compatible with Carthage. Just add it to your Cartfile
.
Note: The OHHTTPStubs.framework
built with Carthage will include all features of OHHTTPStubs
turned on (in other words, all subspecs of the pod), including NSURLSession
and JSON
support, OHPathHelpers
, HTTPMessage
and Mocktail
support, and the Swiftier API.
OHHTTPStubs
supports Swift 3.0 (Xcode 8+), Swift 3.1 (Xcode 8.3+), Swift 3.2 (Xcode 9.0+), Swift 4.0 (Xcode 9.0+), Swift 4.1 (Xcode 9.3+), Swift 4.2 (Xcode 10+), Swift 5.0 (Xcode 10.2), and Swift 5.1 (Xcode 11) however we are only testing Swift 4.x (using Xcode 9.1 and 10.1) and Swift 5.x (using Xcode 10.2 AND 11) in CI.
Here are some details about the correct setup you need depending on how you integrated OHHTTPStubs
into your project.
OHHTTPStubs
is ideal to write unit tests that normally would perform network requests. But if you use it in your unit tests, don't forget to:
[HTTPStubs removeAllStubs]
in your tearDown
method. see this wiki page for more infoOHHTTPStubs
is automatically loaded and installed (at the time the library is loaded in memory), both for:
NSURLConnection
or [NSURLSession sharedSession]
— thanks to this codeNSURLSession
that was created via [NSURLSession sessionWithConfiguration:…]
and using either [NSURLSessionConfiguration defaultSessionConfiguration]
or [NSURLSessionConfiguration ephemeralSessionConfiguration]
configuration — thanks to method swizzling done here in the code.If you need to disable (and re-enable) OHHTTPStubs
— globally or per NSURLSession
— you can use [HTTPStubs setEnabled:]
/ [HTTPStubs setEnabled:forSessionConfiguration:]
.
OHHTTPStubs
can't work on background sessions (sessions created using [NSURLSessionConfiguration backgroundSessionConfiguration]
) because background sessions don't allow the use of custom NSURLProtocols
and are handled by the iOS Operating System itself.OHHTTPStubs
don't simulate data upload. The NSURLProtocolClient
@protocol
does not provide a way to signal the delegate that data has been sent (only that some has been loaded), so any data in the HTTPBody
or HTTPBodyStream
of an NSURLRequest
, or data provided to -[NSURLSession uploadTaskWithRequest:fromData:];
will be ignored, and more importantly, the -URLSession:task:didSendBodyData:totalBytesSent:totalBytesExpectedToSend:
delegate method will never be called when you stub the request using OHHTTPStubs
.OHTTPStubs
has a known issue with redirects that we believe is an Apple bug. It has been discussed here and here. The actual result of this bug is that redirects with a zero second delay may nondeterministically end up with a null response.As far as I know, there's nothing we can do about those three limitations. Please let me know if you know a solution that would make that possible anyway.
OHHTTPStubs
can be used on apps submitted on the App Store. It does not use any private API and nothing prevents you from shipping it.
But you generally only use stubs during the development phase and want to remove your stubs when submitting to the App Store. So be careful to only include OHHTTPStubs
when needed (only in your test targets, or only inside #if DEBUG
sections, or by using per-Build-Configuration pods) to avoid forgetting to remove it when the time comes that you release for the App Store and you want your requests to hit the real network!
This project and library has been created by Olivier Halligon (@aligatr on Twitter) and is under the MIT License.
It has been inspired by this article from InfiniteLoop.dk.
I would also like to thank:
NSInputStream
If you want to support the development of this library, feel free to . Thanks to all contributors so far!