diff options
Diffstat (limited to 'platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/OHHTTPStubsResponse+JSON.h')
-rw-r--r-- | platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/OHHTTPStubsResponse+JSON.h | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/OHHTTPStubsResponse+JSON.h b/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/OHHTTPStubsResponse+JSON.h new file mode 100644 index 0000000000..fc8719df0d --- /dev/null +++ b/platform/ios/test/OHHTTPStubs/OHHTTPStubs/Sources/OHHTTPStubsResponse+JSON.h @@ -0,0 +1,47 @@ +// +// OHHTTPStubsResponse+JSON.h +// OHHTTPStubs +// +// Created by Olivier Halligon on 01/09/13. +// Copyright (c) 2013 AliSoftware. All rights reserved. +// + +#import "OHHTTPStubsResponse.h" + +#ifdef NS_ASSUME_NONNULL_BEGIN + NS_ASSUME_NONNULL_BEGIN + #define _nullable_ __nullable +#else + #define _nullable_ +#endif + + +/** + * Adds convenience methods to manipulate JSON objects directly. + * Pass in an `NSDictionary` or `NSArray` to generate a corresponding JSON output. + */ +@interface OHHTTPStubsResponse (JSON) + +/** + * Builds a response given a JSON object for the response body, status code, and headers. + * + * @param jsonObject Object representing the response body. + * Typically a `NSDictionary`; may be any object accepted by `+[NSJSONSerialization dataWithJSONObject:options:error:]` + * @param statusCode The HTTP Status Code to use in the response + * @param httpHeaders The HTTP Headers to return in the response + * If a "Content-Type" header is not included, "Content-Type: application/json" will be added. + * + * @return An `OHHTTPStubsResponse` describing the corresponding response to return by the stub + * + * @note This method typically calls `responseWithData:statusCode:headers:`, passing the serialized JSON + * object as the data parameter and adding the Content-Type header if necessary. + */ ++ (instancetype)responseWithJSONObject:(id)jsonObject + statusCode:(int)statusCode + headers:(NSDictionary * _nullable_)httpHeaders; + +@end + +#ifdef NS_ASSUME_NONNULL_END + NS_ASSUME_NONNULL_END +#endif |