HttPlaceholder

A very flexible cross platform HTTP stub application.

Programming language: C#

License: MIT License

Tags: Software Development     IDE/Tools    

Latest version: v2020.12.11.114

README

HttPlaceholder Quickly stub away any HTTP service. Report a Bug · Request a Feature · Ask a Question

[](LICENSE)

Table of Contents

• About
  • Built With
• Getting Started
  • Prerequisites
  • Installation
  • Example
• Getting started
• [Documentation](docs/docs.md)
  • Tools
• Roadmap
• Support
• Project assistance
• Contributing
• Authors & contributors
• Security
• License

---

About

HttPlaceholder lets you stub away any HTTP webservice.

It was thought up while I was working at a company which had many interconnected webservices. The development process was very painful, because it meant all the other webservices should also be started on my local dev PC, or I had to use the "development" environment, which did not work for half of the time. HttPlaceholder fills this gap nicely.

HttPlaceholder:

• can easily be installed on your dev PC.
• can be used to easily create stubs, either as separate YAML files, through the API or through the user interface.
• can easily be hosted on any server.
• can use many different HTTP condition checkers and response writers to make your HTTP stubs as specific as you need.

Built With

• .NET 6
• Vue.js
• Bootstrap
• CodeMirror
• ImageSharp

Getting Started

Prerequisites

Linux, Windows and Mac are supported.

Installation

Follow these steps to install / update HttPlaceholder. If you update HttPlaceholder, make sure to read the [changelog](CHANGELOG) to see if there are no breaking changes.

Install on Windows

Set-ExecutionPolicy Bypass -Scope Process -Force; iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/dukeofharen/httplaceholder/master/scripts/Install-Windows.ps1'))

Install on Linux

sudo curl -o- https://raw.githubusercontent.com/dukeofharen/httplaceholder/master/scripts/install-linux.sh | sudo bash

Install on Mac

sudo curl -o- https://raw.githubusercontent.com/dukeofharen/httplaceholder/master/scripts/install-mac.sh | sudo bash

Docker

HttPlaceholder has a Docker image; it can be found here.

Run the following command to run a basic HttPlaceholder container: docker run -p 5000:5000 dukeofharen/httplaceholder:latest

Install as .NET tool

dotnet tool install --global HttPlaceholder

Example

• Install HttPlaceholder (see Installation).
• Create a new .yaml file (e.g. stub.yaml).
• Copy and paste these contents in your new file:

- id: situation-01
  conditions:
    method: GET
    url:
      path:
        equals: /users
      query:
        id:
          equals: 12
        filter:
          equals: first_name
  response:
    statusCode: 200
    text: |
      {
        "first_name": "John"
      }
    headers:
      Content-Type: application/json

• Open the terminal in the folder you've added the stub.yaml file and run the following command: httplaceholder. HttPlaceholder will now start and will load the stubs in the current folder. [](docs/img/httplaceholder_running.png)

• Perform a specific HTTP call to HttPlaceholder so your provided response will be returned.

  • For Linux / Mac (cURL needs to be installed): bash curl "http://localhost:5000/users?id=12&filter=first_name" -D-
  • For Windows (uses Powershell): powershell (Invoke-WebRequest "http://localhost:5000/users?id=12&filter=first_name").RawContent

• You can view and inspect the performed requests in the user interface at http://localhost:5000/ph-ui. [](docs/img/request_in_ui.png)

For more sophisticated examples, go to the [samples](docs/docs.md#samples) to view samples for all supported HTTP condition checkers and response writers. Learn more about HttPlaceholder by reading the [documentation](docs/docs.md).

Documentation

• [Installation](docs/docs.md#installation)
  • [Windows](docs/docs.md#windows)
  • [Linux](docs/docs.md#linux)
  • [Mac](docs/docs.md#mac)
  • [Docker](docs/docs.md#docker)
• [Getting started](docs/docs.md#getting-started)
• [Stub samples](docs/docs.md#samples)
• [REST API](docs/docs.md#rest-api)
• [Configuration](docs/docs.md#configuration)
• [Request conditions](docs/docs.md#request-conditions)
• [Response writers](docs/docs.md#response-writers)
• [Management interface](docs/docs.md#management-interface)

Tools

• [HttPlaceholder REST API client for .NET](docs/docs.md#httplaceholder-rest-api-client-for-net)

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub discussions
• The email which is located in GitHub profile

Project assistance

If you want to say thank you or/and support active development of HttPlaceholder:

• Add a GitHub Star to the project.
• Tweet about HttPlaceholder on your Twitter.
• Send me an email (see my GitHub Profile).

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

We have set up a separate document containing our [contribution guidelines](docs/CONTRIBUTING.md).

Thank you for being involved!

Authors & contributors

The original setup of this repository is by dukeofharen (https://ducode.org).

For a full list of all authors and contributors, check the contributor's page.

Security

HttPlaceholder follows good practices of security, but 100% security can't be granted in software. HttPlaceholder is provided "as is" without any warranty. Use at your own risk.

For more info, please refer to the [security](docs/SECURITY.md).

License

This project is licensed under the MIT license.

See [LICENSE](LICENSE) for more information.