Skip to content

benfalk/req_md

Repository files navigation

ReqMD: HTTP Requests in Markdown

Readable. Executable. Simple.

This is a project focused on representing a human readable markdown format which describes HTTP requests. The goal is to be able to create markdown documents using that specification and leverage this tooling to identify and send them as valid HTTP requests.

To get started read the friendly manual.


The tl;dr is to be able to take a document like this:

Sample document:

Sample Document

And run commands like this:


List requests found in the document:

List Requests


Note

The server in the example is an echo server that replies with the information it was sent. What you are seeing returned is the response of that echo server. This helps demonstrate what the details were in the requests this tool sent.


Send first request in the document:

Send First Request


Adds header to request with environment variable:

Environment Headers


Can set timeouts ( Examples: 50ms, 2sec, 5min )

Error Timeout


Run by request found at a line number:

Run Line 18


Dump requests to JSON:

Dump to JSON