tmavrin/mock-http-server repository overview

⁠Mock HTTP Server

Small and simple mock HTTP server configurable with JSON.

Features:

• The server responds with configured response
• POST and PUT endpoints also have request validation and matching
  • Validation is defined by go-playground/validator⁠ tags.
  • Matching compares request JSON to configured expected JSON
• Error preparing: when you make a request to configured prepareErrorPath, the next request to prepared endpoint will return the prepared error

⁠Prepared error

Example of prepare error request:

POST

{
  "method": "POST",
  "path": "/example-path",
  "status": 401,
  "response": {
    "mock": "example-mock-response",
    "info": { "error": true }
  }
}

⁠Config

The server is configured with config.json file.

If you are mounting a config with docker or have the file anywhere else but project root folder, you can use ENV variable CONFIG_PATH so override it.

⁠Config example

{
  "prepareErrorPath": "/prepareError",
  "handlers": [
    {
      "path": "/example-path",
      "method": "POST",
      "response": {
        "info": { "success": true },
        "data": "post validate request success data"
      },
      "request": {
        "validate": {
          "example": "required,lowercase,min=5"
        },
        "match": {
          "example": "mock-request-body"
        }
      },
      "responseEcho": {
        "example.mock.mock-2.mock-3": "example.mock.mock-2.mock-3"
      },
      "queryParams": {
        "test": {
          "required": false,
          "value": "test-value"
        }
      }
    }
  ]
}

• prepareErrorPath defines a path where requests will be sent to prepare the next request to return error
• handler is an array of handler definitions where:
  • path is URL path
  • method is http method (POST,GET,PATCH, PUT, DELETE)
  • response is a definition of response data you want the mock to return
  • request:
    • validate key-value of properties that you want validated defined by go-playground/validator⁠ tags
    • match configures the mock to check for exact match with request
  • responseEcho is a key-value set of dot notation properties you want to take from request and set in response.
    • Simple example: some.property.you.want.in.response
    • Array example: if [2] for example is present, it means take the 3rd element of array. Example some.[2].property.you.[1].want.in.response
  • queryParam is a map of query params you want to check
    • required if false it will not fail when not sent
    • value value to compare to when it is sent. if not equal it will fail

⁠Port

Serve port is configured by env PORT, but defaults to :8080

⁠How to run

⁠Docker

docker pull tmavrin/mock-http-server

docker run --name=mock-server -e PORT=8080 -e CONFIG_PATH='/path/to/config' tmavrin/mock-http-server

Available ENVIRONMENT variables:

• PORT -> defaults to 8080
• CONFIG_PATH -> defaults to example config from the repo (./config.json)

⁠Repo clone

You can clone the repo and run the server with go (go 1.22 required)

go run .