diff --git a/README.rst b/README.rst index 2f14c4c..f0daa61 100644 --- a/README.rst +++ b/README.rst @@ -12,67 +12,80 @@ 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&code=code `__ - Drips data over a duration after an optional initial delay, then - (optionally) returns with the given status code. -- `/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 +====================================== ================================================================================================================== +Endpoint Description +-------------------------------------- ------------------------------------------------------------------------------------------------------------------ +`/`_ 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`_ 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`_ Drips data over a duration after an optional initial delay, then (optionally) returns with the given status code. +`/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 +`/encoding/utf8`_ Returns page containing UTF-8 data. +====================================== ================================================================================================================== + +.. _/user-agent: http://httpbin.org/user-agent +.. _/headers: http://httpbin.org/headers +.. _/get: http://httpbin.org/get +.. _/: http://httpbin.org/ +.. _/ip: http://httpbin.org/ip +.. _/gzip: http://httpbin.org/gzip +.. _/deflate: http://httpbin.org/deflate +.. _/status/:code: http://httpbin.org/status/418 +.. _/response-headers: http://httpbin.org/response-headers?Content-Type=text/plain;%20charset=UTF-8&Server=httpbin +.. _/redirect/:n: http://httpbin.org/redirect/6 +.. _/redirect-to?url=foo: http://httpbin.org/redirect-to?url=http://example.com/ +.. _/relative-redirect/:n: http://httpbin.org/relative-redirect/6 +.. _/cookies: http://httpbin.org/cookies +.. _/cookies/set?name=value: http://httpbin.org/cookies/set?k1=v1&k2=v2 +.. _/cookies/delete?name: http://httpbin.org/cookies/delete?k1&k2 +.. _/basic-auth/:user/:passwd: http://httpbin.org/basic-auth/user/passwd +.. _/hidden-basic-auth/:user/:passwd: http://httpbin.org/hidden-basic-auth/user/passwd +.. _/digest-auth/:qop/:user/:passwd: http://httpbin.org/digest-auth/auth/user/passwd +.. _/stream/:n: http://httpbin.org/stream/20 +.. _/delay/:n: http://httpbin.org/delay/3 +.. _/drip: http://httpbin.org/drip?numbytes=5&duration=5&code=200 +.. _/html: http://httpbin.org/html +.. _/robots.txt: http://httpbin.org/robots.txt +.. _/deny: http://httpbin.org/deny +.. _/cache: http://httpbin.org/cache +.. _/cache/:n: http://httpbin.org/cache/60 +.. _/bytes/:n: http://httpbin.org/bytes/1024 +.. _/stream-bytes/:n: http://httpbin.org/stream-bytes/1024 +.. _/links/:n: http://httpbin.org/links/10 +.. _/forms/post: http://httpbin.org/forms/post +.. _/xml: http://httpbin.org/xml +.. _/encoding/utf8: http://httpbin.org/encoding/utf8 + DESCRIPTION -----------