Skip to content
Format for HTTP exchanges and libraries for working with that format.
HTML Shell
Branch: master
Clone or download

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
valid
._config.yml
.gitignore
LICENSE
README.md
_config.yml
git
http-types-schema.json
test.sh
validate.html

README.md

Build Status MIT licensed

http-types is a format for HTTP exchanges and libraries for reading and writing that format.

Each HTTP exchange (request and response) is a JSON object following the http-types-schema.json schema, with a series of exchanges being represented with an object per line, JSON Lines style.

Why?

At Meeshkan we think that HTTP traffic is interesting and that much can be learned from it!

Having a simple format that can be created from and processed in a variety of programming languages helps out with that.

Libraries

For most use cases you can use one of the below libraries to read and write HTTP exchanges in the http-types format and do not need to about the details of the JSON format.

Don't see your language of choice here? If you write your own and tell us about it we'll add it to this list:

Middlewares

Middlewares are interceptors of traffic allowing http-types output to be generated from intercepted traffic. Currently there is only one available:

JSON representation

While most use cases can be covered by using one of the above listed libraries, you may want to generated or process the JSON data directly.

The format is described in http-types-schema.json and an example of a single HTTP exchange is given below.

{
  "request": {
    "method": "get",
    "protocol": "http",
    "host": "example.com",
    "headers": {
      "accept": "*/*",
      "user-agent": "Mozilla/5.0 (pc-x86_64-linux-gnu) Siege/3.0.8"
    },
    "pathname": "/user/repos",
    "query": { "param": "value" },
    "timestamp": "2018-11-13T20:20:39+01:00"
  },
  "response": {
    "statusCode": 200,
    "body": "(response body string)",
    "headers": {
      "content-length": "1999",
      "content-type": "text/html; charset=utf-8"
    },
    "timestamp": "2018-11-13T20:20:39+02:00"
  }
}

As an alternative to providing pathname and query as separate properties, one can provide a single path property:

  "request": {
    [...]
    "path": "/user/repos?param=value",
    [...]
  },

A series of request and responses uses the JSON Lines format, with each line being an object as defined by the above mentioned schema.

With the jsonschema command-line validation tool installed one can verify the first row of an input file with the command:

jsonschema -i <(head -n 1 resources/sample.jsonl) http-types-schema.json

Binary content

Request or response bodies with binary content are currently out of scope - leave those out completely or remove the body field for these.

Reporting issues

Create an issue if you encounter a problem, have a question or an idea.

You can’t perform that action at this time.