mirror of
https://github.com/edgurgel/httparrot
synced 2025-04-05 00:02:41 -04:00
3b7d5d5eea
Besides other documentation changes, this commit ensures the generated HTML doc for HexDocs.pm will become the source of truth for this Elixir library and leverage on latest features of ExDoc.
56 lines
2.6 KiB
Markdown
56 lines
2.6 KiB
Markdown
# HTTParrot
|
||
|
||
[](https://travis-ci.org/edgurgel/httparrot)
|
||
[](https://hex.pm/packages/httparrot)
|
||
[](https://hexdocs.pm/httparrot/)
|
||
[](https://hex.pm/packages/httparrot)
|
||
[](https://github.com/edgurgel/httparrot/blob/master/LICENSE.md)
|
||
[](https://github.com/edgurgel/httparrot/commits/master)
|
||
|
||
HTTP server built on top of [Cowboy](https://hex.pm/packages/cowboy) using (mostly) `cowboy_rest` handlers to serve useful endpoints for testing purposes. Its goal is to be as close as possible to [HTTPBin](http://httpbin.org).
|
||
|
||
## Endpoints
|
||
|
||
* `/` This page.
|
||
* `/ip` Returns Origin IP.
|
||
* `/user-agent` Returns user-agent.
|
||
* `/headers` Returns header dict.
|
||
* `/get` Returns GET data.
|
||
* `/post` Returns POST data.
|
||
* `/put` Returns PUT data.
|
||
* `/patch` Returns PATCH data.
|
||
* `/delete` Returns DELETE data
|
||
* `/gzip` Returns gzip-encoded data.
|
||
* `/status/:code` Returns given HTTP Status code.
|
||
* `/response-headers?key=val` Returns given response headers.
|
||
* `/redirect/:n` 301 Redirects n times.
|
||
* `/redirect-to?url=foo` 301 Redirects to the foo URL.
|
||
* `/relative-redirect/:n` 301 Relative redirects n times.
|
||
* `/cookies` Returns cookie data.
|
||
* `/cookies/set?name=value` Sets one or more simple cookies.
|
||
* `/cookies/set/name/value` Sets one cookie .
|
||
* `/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.
|
||
* `/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 header is provided, when it returns a 304 Not Modified.
|
||
* `/base64/:value` Decodes base64url-encoded string.
|
||
* `/image` Return an image based on Accept header.
|
||
* `/websocket` Echo message received through websocket
|
||
|
||
## TODO
|
||
|
||
* [ ] `/deflate` Returns deflate-encoded data.
|
||
* [ ] `/digest-auth/:qop/:user/:passwd` Challenges HTTP Digest Auth.
|
||
|
||
## Copyright and License
|
||
|
||
Copyright (c) 2013 Eduardo Gurgel <eduardo@gurgel.me>
|
||
|
||
This work is free. You can redistribute it and/or modify it under the
|
||
terms of the MIT License. See the [LICENSE.md](./LICENSE.md) file for more details.
|