simplify readme

This commit is contained in:
2017-03-16 20:00:36 -04:00
parent 017810bcbd
commit fb6d2f745f
-111
View File
@@ -12,100 +12,6 @@ flavors by `Heroku <https://www.heroku.com/>`__.
|Build Status|
ENDPOINTS
---------
======================================= ==================================================================================================================
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 or random if more than one are given.
`/response-headers?header=val`_ Returns given response headers.
`/redirect/:n`_ 302 Redirects *n* times.
`/redirect-to?url=foo`_ 302 Redirects to the *foo* URL.
`/redirect-to?url=foo&status_code=307`_ 307 Redirects to the *foo* URL.
`/relative-redirect/:n`_ 302 Relative redirects *n* times.
`/absolute-redirect/:n`_ 302 Absolute 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 up to 10MB data over a duration after an optional initial delay, then (optionally) returns with the given status code.
`/range/:n`_ Streams *n* bytes, and allows specifying a *Range* header to select a subset of the data. Accepts a *chunk\_size* and request *duration* parameter.
`/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.
`/image`_ Returns an image based on sent Accept header.
`/image/png`_ Returns a PNG image.
`/image/jpeg`_ Returns a JPEG image.
`/image/webp`_ Returns a WEBP image.
`/image/svg`_ Returns a SVG image.
`/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?header=val: 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/
.. _/redirect-to?url=foo&status_code=307:
http://httpbin.org/redirect-to?url=http://example.com/&status_code=307
.. _/relative-redirect/:n: http://httpbin.org/relative-redirect/6
.. _/absolute-redirect/:n: http://httpbin.org/absolute-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
.. _/range/:n: http://httpbin.org/range/1024
.. _/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
.. _/image: http://httpbin.org/image
.. _/image/png: http://httpbin.org/image/png
.. _/image/jpeg: http://httpbin.org/image/jpeg
.. _/image/webp: http://httpbin.org/image/webp
.. _/image/svg: http://httpbin.org/image/svg
.. _/forms/post: http://httpbin.org/forms/post
.. _/xml: http://httpbin.org/xml
.. _/encoding/utf8: http://httpbin.org/encoding/utf8
DESCRIPTION
-----------
@@ -213,23 +119,6 @@ Or install and run it directly:
$ pip install -e httpbin
$ python -m httpbin.core [--port=PORT] [--host=HOST]
Changelog
---------
- 0.5.0:
- Allow /redirect-to to work with multiple methods
- Allow MD5 or SHA-256 to be chosen as algorithms for HTTP Digest Auth
- Set a 10MB limit on /drip
- 0.4.1: Added floating-point support for /delay endpoint
- 0.4.0: New /image/svg endpoint, add deploy to heroku button, add 406 response to /image, and don't always emit the transfer-encoding header for stream endpoint.
- 0.3.0: A number of new features, including a /range endpoint, lots of
bugfixes, and a /encoding/utf8 endpoint
- 0.2.0: Added an XML endpoint. Also fixes several bugs with unicode,
CORS headers, digest auth, and more.
- 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
------