wotus/httpbin

HTTP Request & Response Service, written in Python + Flask.

httpbin(1): HTTP Request & Response Service

Freely hosted in HTTP, HTTPS & EU flavors by Runscope

ENDPOINTS

• / This page.
• /ip Returns Origin IP.
• /user-agent Returns user-agent.
• /headers Returns header dict.
• /get Returns GET data.
• /post Returns POST data.
• /patch Returns PATCH data.
• /put Returns PUT data.
• /delete Returns DELETE data
• /gzip Returns gzip-encoded data.
• /deflate Returns deflate-encoded data.
• /status/:code Returns given HTTP Status code.
• /response-headers?key=val Returns given response headers.
• /redirect/:n 302 Redirects n times.
• /redirect-to?url=foo 302 Redirects to the foo URL.
• /relative-redirect/:n 302 Relative redirects n times.
• /cookies Returns cookie data.
• /cookies/set?name=value Sets one or more simple cookies.
• /cookies/delete?name Deletes one or more simple cookies.
• /basic-auth/:user/:passwd Challenges HTTPBasic Auth.
• /hidden-basic-auth/:user/:passwd 404'd BasicAuth.
• /digest-auth/:qop/:user/:passwd Challenges HTTP Digest Auth.
• /stream/:n Streams n–100 lines.
• /delay/:n Delays responding for n–10 seconds.
• /drip?numbytes=n&duration=s&delay=s Drips data over a duration after an optional initial delay.
• /html Renders an HTML Page.
• /robots.txt Returns some robots.txt rules.
• /deny Denied by robots.txt file.
• /cache Returns 200 unless an If-Modified-Since or If-None-Match header is provided, when it returns a 304.
• /cache/:n Sets a Cache-Control header for n seconds.
• /bytes/:n Generates n random bytes of binary data, accepts optional seed integer parameter.
• /stream-bytes/:n Streams n random bytes of binary data, accepts optional seed and chunk_size integer parameters.
• /links/:n Returns page containing n HTML links.
• /forms/post HTML form that submits to /post
• /xml Returns some XML

DESCRIPTION

Testing an HTTP Library can become difficult sometimes. PostBin.org is fantastic for testing POST requests, but not much else. This exists to cover all kinds of HTTP scenarios. Additional endpoints are being considered.

All endpoint responses are JSON-encoded.

EXAMPLES

$ curl http://httpbin.org/ip

{"origin": "24.127.96.129"}

$ curl http://httpbin.org/user-agent

{"user-agent": "curl/7.19.7 (universal-apple-darwin10.0) libcurl/7.19.7 OpenSSL/0.9.8l zlib/1.2.3"}

$ curl http://httpbin.org/get

{
   "args": {},
   "headers": {
      "Accept": "*/*",
      "Connection": "close",
      "Content-Length": "",
      "Content-Type": "",
      "Host": "httpbin.org",
      "User-Agent": "curl/7.19.7 (universal-apple-darwin10.0) libcurl/7.19.7 OpenSSL/0.9.8l zlib/1.2.3"
   },
   "origin": "24.127.96.129",
   "url": "http://httpbin.org/get"
}

$ curl -I http://httpbin.org/status/418

HTTP/1.1 418 I'M A TEAPOT
Server: nginx/0.7.67
Date: Mon, 13 Jun 2011 04:25:38 GMT
Connection: close
x-more-info: http://tools.ietf.org/html/rfc2324
Content-Length: 135

$ curl https://httpbin.org/get?show_env=1

{
  "headers": {
    "Content-Length": "",
    "Accept-Language": "en-US,en;q=0.8",
    "Accept-Encoding": "gzip,deflate,sdch",
    "X-Forwarded-Port": "443",
    "X-Forwarded-For": "109.60.101.240",
    "X-Heroku-Dynos-In-Use": "1",
    "Host": "httpbin.org",
    "Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8",
    "User-Agent": "Mozilla/5.0 (X11; Linux i686) AppleWebKit/535.11 (KHTML, like Gecko) Chrome/17.0.963.83 Safari/535.11",
    "X-Request-Start": "1350053933441",
    "Accept-Charset": "ISO-8859-1,utf-8;q=0.7,*;q=0.3",
    "Connection": "keep-alive",
    "X-Forwarded-Proto": "https",
    "Cookie": "_gauges_unique_day=1; _gauges_unique_month=1; _gauges_unique_year=1; _gauges_unique=1; _gauges_unique_hour=1",
    "X-Heroku-Queue-Depth": "0",
    "X-Heroku-Queue-Wait-Time": "11",
    "Content-Type": ""
  },
  "args": {
    "show_env": "1"
  },
  "origin": "109.60.101.240",
  "url": "http://httpbin.org/get?show_env=1"
}

Installing and running from PyPI

You can install httpbin as a library from PyPI and run it as a WSGI app. For example, using Gunicorn:

$ pip install httpbin
$ gunicorn httpbin:app

Changelog

• 0.1.2: Fix a couple Python3 bugs with the random byte endpoints, fix a bug when uploading files without a Content-Type header set.
• 0.1.1: Added templates as data in setup.py
• 0.1.0: Added python3 support and (re)publish on PyPI

AUTHOR

A Kenneth Reitz Project.

SEE ALSO

http://python-requests.org