mirror of
https://github.com/kennethreitz/httpbin.git
synced 2026-06-05 23:00:18 +00:00
Tom V
85 lines
3.2 KiB
Markdown
85 lines
3.2 KiB
Markdown
httpbin(1): HTTP Request & Response Service
|
||
===========================================
|
||
|
||
Freely hosted in [HTTP](http://httpbin.org) &
|
||
[HTTPS](https://httpbin.org) flavors.
|
||
|
||
## ENDPOINTS
|
||
|
||
- [`/`](http://httpbin.org/) This page.
|
||
- [`/ip`](http://httpbin.org/ip) Returns Origin IP.
|
||
- [`/user-agent`](http://httpbin.org/user-agent) Returns user-agent.
|
||
- [`/headers`](http://httpbin.org/headers) Returns header dict.
|
||
- [`/get`](http://httpbin.org/get) Returns GET data.
|
||
- [`/post`](http://hurl.it/hurls/190ccaa90ee1ed35d34abfa4ac6ef088bc319402/d834bcdf7718c44c4184bf914ee473b6ebd8e566) Returns POST data.
|
||
- [`/put`](http://hurl.it/hurls/18016368fa5e5eef80db935f5dae615d5858a4a4/a512d904f5da64df9627ee998c040f7874d6436a) Returns PUT data.
|
||
- [`/delete`](http://hurl.it/hurls/6faafea5191f77172fca4cfe1505739230d5f769/bc255ffc69e04c2c8b968822c59544746bbb872c) Returns DELETE data
|
||
- [`/gzip`](http://httpbin.org/gzip) Returns gzip-encoded data.
|
||
- [`/status/:code`](http://httpbin.org/status/418) Returns given HTTP Status code.
|
||
- [`/response-headers?key=val`](http://httpbin.org/response-headers?Content-Type=text/plain;%20charset=UTF-8&Server=httpbin) Returns given response headers.
|
||
- [`/redirect/:n`](http://httpbin.org/redirect/6) 302 Redirects *n* times.
|
||
- [`/relative-redirect/:n`](http://httpbin.org/relative-redirect/6) 302 Relative redirects *n* times.
|
||
- [`/cookies`](http://httpbin.org/cookies) Returns cookie data.
|
||
- [`/cookies/set/:name/:value`](http://httpbin.org/cookies/set/key/value) Sets a simple cookie.
|
||
- [`/basic-auth/:user/:passwd`](http://httpbin.org/basic-auth/user/passwd) Challenges HTTPBasic Auth.
|
||
- [`/hidden-basic-auth/:user/:passwd`](http://httpbin.org/hidden-basic-auth/user/passwd) 404'd BasicAuth.
|
||
- [`/digest-auth/:qop/:user/:passwd`](http://httpbin.org/digest-auth/auth/user/passwd) Challenges HTTP Digest Auth.
|
||
- [`/stream/:n`](http://httpbin.org/stream/20) Streams *n*–100 lines.
|
||
- [`/delay/:n`](/delay/3) Delays responding for *n*–10 seconds.
|
||
|
||
|
||
## 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 (e.g. `/deflate`).
|
||
|
||
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
|
||
|
||
|
||
## AUTHOR
|
||
|
||
A [Kenneth Reitz](http://kennethreitz.com/pages/open-projects.html)
|
||
Project.
|
||
|
||
## SEE ALSO
|
||
|
||
<http://python-requests.org>
|
||
|