Skip to content

Commit f73b3af

Browse files
committed
Add response example to README and update docker image name
1 parent 3429360 commit f73b3af

File tree

1 file changed

+35
-4
lines changed

1 file changed

+35
-4
lines changed

README.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,59 @@
44
55
Requires Python >= 3.6
66

7-
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/ba14f84a3f824410be0a6f6670de012a)](https://app.codacy.com/gh/jaswdr/http-dump?utm_source=github.com&utm_medium=referral&utm_content=jaswdr/http-dump&utm_campaign=Badge_Grade)
7+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/c7f663d457a04be3a72dbf69252ad387)](https://www.codacy.com/gh/jaswdr/http-dump/dashboard?utm_source=github.com&utm_medium=referral&utm_content=jaswdr/http-dump&utm_campaign=Badge_Grade)
88
[![Gitpod ready-to-code](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/jaswdr/http-dump)
99
[![Hits](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fgithub.com%2Fjaswdr%2Fhttp-dump&count_bg=%2379C83D&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=hits&edge_flat=false)](https://hits.seeyoufarm.com)
1010

1111
## Getting Started
1212

1313
```
14-
$ docker run -p 8080:80 ghcr.io/jaswdr/http-dump
14+
$ docker run -p 8080:80 ghcr.io/jaswdr/http-dump:master
1515
* Serving Flask app 'dump' (lazy loading)
1616
* Environment: production
1717
WARNING: This is a development server. Do not use it in a production deployment.
1818
Use a production WSGI server instead.
1919
* Debug mode: on
2020
* Running on all addresses.
2121
WARNING: This is a development server. Do not use it in a production deployment.
22-
* Running on http://<your-ip>:80/ (Press CTRL+C to quit)
22+
* Running on http://10.0.0.1:80/ (Press CTRL+C to quit)
2323
* Restarting with stat
2424
* Debugger is active!
2525
* Debugger PIN: 995-808-312
2626
```
2727

28-
Then http://localhost:8080.
28+
Then open **http://localhost:8080/?foo=bar&bar=foo**
29+
30+
Example of response:
31+
```
32+
{
33+
"uuid": "9b513c673ee840b581b964b0aca3f62c",
34+
"endpoint": "dump",
35+
"method": "GET",
36+
"cookies": {
37+
"grafana_session": "88deff3280a7bcaab18922192d282442",
38+
"cookie-name": "cookie-value"
39+
},
40+
"data": "b''",
41+
"headers": {
42+
"Host": "10.0.0.1:8080",
43+
"User-Agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:92.0) Gecko/20100101 Firefox/92.0",
44+
"Accept": "text/html,application/xhtml+xml,application/xml;q=0.9,image/webp,*/*;q=0.8",
45+
"Accept-Language": "en-US,en;q=0.5",
46+
"Accept-Encoding": "gzip, deflate",
47+
"Dnt": "1",
48+
"Connection": "keep-alive",
49+
"Upgrade-Insecure-Requests": "1"
50+
},
51+
"args": {
52+
"foo": "bar",
53+
"bar": "foo"
54+
},
55+
"form": {},
56+
"remote_addr": "10.0.0.2",
57+
"files": []
58+
}
59+
```
2960

3061
## Get involved
3162

0 commit comments

Comments
 (0)