Skip to content

Latest commit

 

History

History
160 lines (108 loc) · 4.57 KB

README.md

File metadata and controls

160 lines (108 loc) · 4.57 KB
Raw

dummyhttp

CI Docker Hub Crates.io license Lines of Code

A super simple HTTP server that replies with a fixed body and a fixed response code

This is a simple, small, self-contained, cross-platform CLI tool for debugging and testing. It allows you to return arbitrary HTTP responses and log incoming request data. HTTP/2 support included.

How to use

Log all incoming request data

Running dummyhttp -vv results in this neat output:

Pretty log

Running with no arguments always returns 200 on all interfaces at port 8080

dummyhttp
curl -v localhost:8080
# < HTTP/1.1 200 OK
# < content-length: 10
# < date: Sat, 09 Jun 2018 13:56:14 GMT
# <
# dummyhttp

Always emit 400 Bad Request

dummyhttp -c 400
curl -v localhost:8080
# < HTTP/1.1 400 Bad Request
# < content-length: 10
# < date: Sat, 09 Jun 2018 13:57:53 GMT
# <
# dummyhttp

Always return a certain string

dummyhttp -b "Hello World"
curl -v localhost:8080
# < HTTP/1.1 200 OK
# < content-length: 12
# < date: Sat, 09 Jun 2018 13:58:57 GMT
# <
# Hello World

Return a specific header

dummyhttp -b '{"Hello": "World"}' -H "content-type:application/json"
curl -v localhost:8080
# < HTTP/1.1 200 OK
# < content-type: application/json
# < date: Wed, 24 Aug 2022 00:55:35 +0200
# < content-length: 18
# <
# {"Hello": "World"}

How to install

Static builds: These offered for Linux, OSX, and Windows in various architectures over at the the releases page. Grab a binary corresponding to your architecture.

On Linux and OSX, you need to run chmod +x on the binary to be able to run it. For example:

chmod +x dummyhttp-1.0.2-x86_64-unknown-linux-musl

Afterwards, you can run it:

./dummyhttp-1.0.2-x86_64-unknown-linux-musl

With Cargo: If you have a somewhat recent version of Rust and Cargo installed, you can run

cargo install dummyhttp
dummyhttp

Full options

Super simple HTTP server that replies with a fixed body and a fixed response code

Usage: dummyhttp [OPTIONS]

Options:
  -q, --quiet
          Be quiet (log nothing)

  -v, --verbose...
          Be verbose (log data of incoming and outgoing requests). If given twice it will also log the body data

  -p, --port <PORT>
          Port on which to listen

          [default: 8080]

  -H, --headers <HEADERS>
          Headers to send (format: key:value)

  -c, --code <CODE>
          HTTP status code to send

          [default: 200]

  -b, --body <BODY>
          HTTP body to send

          Supports Tera-based templating (https://tera.netlify.app/docs/) with a few additional
          functions over the default built-ins:

          uuid() - generate a random UUID
          lorem(words) - generate `words` lorem ipsum words

          Example: dummyhttp -b "Hello {{ uuid() }}, it's {{ now() | date(format="%Y") }} {{ lorem(words=5)}}"

          [default: dummyhttp]

  -i, --interface <INTERFACE>
          Interface to bind to

          [default: 0.0.0.0]

  -d, --delay <DELAY>
          Delay in milliseconds before sending the response in milliseconds

          [default: 0]

      --print-completions <shell>
          Generate completion file for a shell

          [possible values: bash, elvish, fish, powershell, zsh]

      --print-manpage
          Generate man page

      --tls-cert <TLS_CERT>
          TLS certificate to use

      --tls-key <TLS_KEY>
          TLS private key to use

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

Releasing

This is mostly a note for me on how to release this thing:

  • Make sure CHANGELOG.md is up to date.
  • cargo release <version>
  • cargo release --execute <version>
  • Releases will automatically be deployed by GitHub Actions.
  • Update Arch package.