FakeApi provides the ability to send HttpWebRequest and get HttpWebResponses without a server.

• You are waiting for your backend colleagues to finish developing the Web Api?
• You need to quickly do a demo of a software and you do not have the time to develop Web Api?
• Or you are writing unit tests and you have to mock HttpWebResponse?

FakeApi is for you!

First of all add to your project a json configuration file named as you like.

• HttpWebResponse default values configuration

In this file, you can define default values for all properties available in HttpWebResponse .Net and object than will be use by FakeApi to build responses when you are sending HttpWebRequest. These values will be used by default for all apis that you will configure in this file and must be declare at the root path like bellow:

{ "defaultDelay": 500, "defaultHttpCode": 200, "defaultMethod": "GET" }

• Web Api configuration

Now, you can define your web api configuration:

"apis": [ { "url": "http://localhost:8080/api/users/{idUser}", "responses": [ { "active": 1, "delay": 300, "httpCode": 200, "response": "{ 'firstname': 'john', 'lastname':'doe', 'id': 567 }" } ] }

For each web api you can set many responses. The first response flagged as active (active = 1) will be used by FakeApi. At runtime you can switch between responses with changing active property value. Note that you can use template segment in your url configuration (/{idUser}). You can also override all default values defined at the root path in each apis configuration.

• How to return data from file?

Simply set the "file" property into your api configuration:

{ "url": "http://localhost:8080/api/get-file", "responses": [ { "active": 1, "httpCode": 200, "file": "DownloadFile.txt" } ] }

• How to add cookie and header?

You can add cookies and headers into HttpWebResponse:

{ "url": "http://localhost:8080/api/orders/{orderId}/addresses/{addressId}}", "responses": [ { "active": 1, "delay": 135, "httpCode": 200, "cookies": [ { "name": "cookie1", "value": "valCookie1", "comment": "Comment1", "discard": 0, "domain": "domain1", "expired": 1, "expires": "2012-10-12", "httpOnly": 1, "path": "path1", "secure": 1, "version": 54 }, { "name": "cookie2", "value": "valCookie2" } ], "headers": [ { "name": "header1", "value": "valHeader1" }, { "name": "header2", "value": "valHeader2 " } ], "response": "{ 'orderId': 345, 'streetAddress':'2762 Highland Drive', 'city': 'Nina' }" }

• How to throw a WebException?

Maybe you will have to test how your code reacts when a web exception is throwing. To do that, you need to set the "webExceptionMessage" property:

{ "url": "http://localhost:8080/api/ad/{adId}", "responses": [ { "active": 1, "httpCode": 400, "webExceptionMessage": "Invalid ad id" } ] }

• How to throw a custom exception?

You can force FakeApi to throw your own exceptions:

{ "url": "http://localhost:8080/api/ad/{adId}/custom-error", "responses": [ { "active": 1, "httpCode": 500, "customApiException": { "fullTypeName": "App.CustomWebException, App", "constructorArgs": [ "custom exception message" ] } } ] }

• Create a HttpWebRequest and use FakeApi

Finally you have to create your web request and use the FakeHttpRequester provided by FakeApi to get the corresponding HttpWebResponse:

var serviceCollection = new ServiceCollection(); #if DEBUG serviceCollection.AddScoped<IHttpRequester, FakeHttpRequester>(provider => { return new FakeHttpRequester("api.cfg.json"); }); #endif var serviceProvider = serviceCollection.BuildServiceProvider(); var httpRequester = serviceProvider.GetService<IHttpRequester>(); //Get user request var getUserRequest = (HttpWebRequest)WebRequest.Create("http://localhost:8080/api/users/56"); var getUserResponse = httpRequester.GetResponse(getUserRequest); using (var stream = new StreamReader(getUserResponse.GetResponseStream())) { var data = stream.ReadToEnd(); var user = JsonConvert.DeserializeObject<User>(data); Console.WriteLine($"json data from {getUserRequest.RequestUri}"); Console.WriteLine($"Firstname : {user.Firstname} | Lastname : {user.Lastname} | Id : {user.Id}"); }

• IHttpRequester

In production, replace the FakeHttpRequester implemention of FakeApi by your own implementation. FakeHttpRequester implements IHttpRequester to provide method to send HttpWebRequest synchronous or asynchronous.

/// <summary> /// Provides method to sending a web request /// </summary> public interface IHttpRequester { /// <summary> /// Gets the web response for <paramref name="request"/> /// </summary> HttpWebResponse GetResponse(HttpWebRequest request); /// <summary> /// Gets the web response async for <paramref name="request"/> /// </summary> Task<HttpWebResponse> GetResponseAsync(HttpWebRequest request); }

• int DefaultDelay (simulate server latence)
• int DefaultHttpCode
• long DefaultContentLength
• string DefaultContentType
• bool DefaultIsFromCache
• bool DefaultIsMutuallyAuthenticated
• string DefaultMethod
• string DefaultResponseUri
• string DefaultResponse
• string DefaultStatusDescription
• array DefaultCookies

• int Delay (simulate server latence)
• int HttpCode
• long ContentLength
• string ContentType
• bool IsFromCache
• bool IsMutuallyAuthenticated
• string Method
• string ResponseUri
• string Response
• string StatusDescription
• string WebExceptionMessage
• object CustomApiException
• array Cookies
• array Headers

• string name
• string value
• string comment
• bool discard
• string domain
• bool expired
• dateTime expires
• bool httpOnly
• string path
• bool secure
• int version

• string name
• string value

{ "defaultDelay": 500, "defaultHttpCode": 200, "defaultMethod": "GET", "apis": [ { "url": "http://localhost:8080/api/users/{idUser}", "responses": [ { "active": 1, "delay": 300, "response": "{ 'firstname': 'john', 'lastname':'doe', 'id': 567 }" } ] }, { "url": "http://localhost:8080/api/orders/{orderId}/addresses/{addressId}}", "responses": [ { "active": 1, "delay": 135, "cookies": [ { "name": "cookie1", "value": "valCookie1" }, { "name": "cookie2", "value": "valCookie2" } ], "headers": [ { "name": "header1", "value": "valHeader1" }, { "name": "header2", "value": "valHeader2 " } ], "response": "{ 'orderId': 345, 'streetAddress':'2762 Highland Drive', 'city': 'Nina' }" }, { "active": 0, "delay": 5000, "httpCode": 203, "response": "{ 'orderId': 345, 'streetAddress':'2762 Highland Drive', 'city': 'Nina' }" } ] }, { "url": "http://localhost:8080/api/ad/{adId}", "responses": [ { "active": 1, "httpCode": 400, "webExceptionMessage": "Invalid ad id" } ] }, { "url": "http://localhost:8080/api/ad/{adId}/custom-error", "responses": [ { "active": 1, "httpCode": 500, "customApiException": { "fullTypeName": "App.CustomWebException, App", "constructorArgs": [ "custom exception message" ] } } ] }, { "url": "http://localhost:8080/api/get-file", "responses": [ { "active": 1, "file": "DownloadFile.txt" } ] } ] } 

You can find a full project example under Example solution folder