rest-mock-core's Introduction

rest-mock-core

A simple http server for using in test projects which test .net core based projects.

Problem

When I started to write some tests for a dotnet core app, I realized that many libraries do not work on that platform. One of my problems was to find an appropriate HTTP Server Mock library. Therefore I started to write this project.

Install

You can install rest-mock-core with NuGet Package Manager Console:

Install-Package rest-mock-core

Or via the .NET Core command-line interface:

dotnet add package rest-mock-core

Usage

You can create and run a mock server as below. Default url is http://localhost:5000 which its port could be changed on the constructor:

HttpServer mockServer = new HttpServer(5001);
mockServer.Run();

Then you can use any http client sending request to it.

HttpClient httpClient = new HttpClient(5001);

If you call the root of server, it will return "It Works!" with a OK status code (200).
You can use server.Config to manage requests, then server will return configured responses to your requests :

mockServer.Config.Get("/api/product/").Send("It Really Works!");

If you call a address which you never configured, you will receive "Page not found!" with status code (404).

There are some options to manage requests better:

mockServer.Config.Get("/api/v1/product/123").Send("It Really Works!");
mockServer.Config.Post("/api/v2/store/a123b").Send("Failed!", 503);
mockServer.Config.Get("/messages/123").Send(context =>
            {
                context.Response.StatusCode = 200;
                string response = "<h1>Your new message<h1>";
                byte[] buffer = System.Text.Encoding.UTF8.GetBytes(response);
                buffer = System.Text.Encoding.UTF8.GetBytes(response);
                context.Response.Body.WriteAsync(buffer, 0, buffer.Length);
            });