http-server-sim 1.1.0.420-beta

http-server-sim

HTTP Server Simulator is a .NET tool that runs a Web API simulating HTTP endpoints, supporting the development and testing of components that use HTTP.

http-server-sim can be called from the shell/command line.

Usage

Installation

Install the latest version from NuGet:

dotnet tool install --global http-server-sim

Once http-server-sim is installed as a global tool, it can be executed from any folder. For other versions and more information, visit NuGet and dotnet tool install.

Rule file

The simulation of endpoints is based on a rule file. Here’s how it can be set up:

1. Create a rule file defining the endpoints and their behaviors.
2. Place the rule file in the appropriate directory.
3. Run the simulator with the rule file.

Example of rule file.

{
  "rules": [
    {
      "name": "customers-post",
      "description": "",
      "conditions": [
        { "field": "Method", "operator": "Equals", "value": "POST" },
        { "field": "Path", "operator": "Contains", "value": "/customers" }
      ],
      "response": {
        "statusCode": 200
      }
    }
  ]
}

Example command (assuming that the file rule.json is in the current folder where the command http-server-sim is being executed):

http-server-sim --Rules rules.json

The following POST request is handled using rule customers-post:

curl --location 'http://localhost:5000/customers' --header 'Content-Type: application/json' --data '{"id":10,"name":"Juan"}' -v

http-server-sim returns a response with 200.

The following GET request:

curl --location 'http://localhost:5000/customers' -v

returns 404 with content Rule matching request not found

http-server-sim output:

Request:
HTTP/1.1 - GET - http://localhost:5000/customers
Headers:
  Accept: */*
  Host: localhost:5000
  User-Agent: curl/8.7.1
Body:
[Not present]
End of Request

warn: HttpServerSim.App[0]
      Rule matching request not found.

Response:
Status Code: 404
Headers:
[Not present]
Body:
Rule matching request not found
End of Response

http-server-sim CLI options

Rule conditions

When http-server-sim processes a request, it uses rule conditions to match a rule to the request.

Example of conditions:

"conditions": [
  { "field": "Method", "operator": "Equals", "value": "POST" },
  { "field": "Path", "operator": "Contains", "value": "/customers" }
]

A rule with these conditions is applied when:

• The request method is POST, and
• The URL path contains /customers.

There are two types of conditions, Method and Path

1. Method Conditions: These specify the HTTP method (e.g., GET, POST) that the request must match.
2. URL Path Conditions: These specify the URL path that the request must match.

The supported operators are: Equals, StartWith, and Contains

Response messages

When http-server-sim identifies a rule that matches a request, it prepares a response message based on the response section of the rule.

Response properties:

Example of a response defining a message with status code 400.

"response": {
  "statusCode": 400
  }

Example of a response defining a message with status code 200 and headers Server (with a single value) and header-1 (with multiple values)

"response": {
  "statusCode": 200,
  "headers": [
    { "key": "Server", "value": ["http-server-sim"] },
    { "key": "header-1", "value": ["val-1", "val-2"] }
  ]
}

Example of a response with a plain text content.

"response": {
  "contentType": "text/plain",
  "contentValue": "Thank you for the notification",
}

Example of a response using a json file that exists in the current directory.

"response": {
  "contentType": "application/json",
  "contentValue": "person-1.json",
  "contentValueType": "File"
}

Example of a response using an in-line json.

"response": {
  "contentType": "application/json",
  "contentValue": "{\"name\":\"Juan\"}"
}

Example of a response using a json file that exists in the current directory and compressing the content with gzip.

"response": {
  "contentType": "application/json",
  "contentValue": "person-1.json",
  "contentValueType": "File",
  "encoding": "GZip"
}