Skip to content

Commit 45e5dd0

Browse files
committed
minor change to README
1 parent 2fa15f4 commit 45e5dd0

File tree

1 file changed

+24
-9
lines changed

1 file changed

+24
-9
lines changed

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,57 @@
1-
# HTTPlex - test and debug HTTP requests
1+
# HTTPlex - a simple HTTP request & response service
22

33
HTTPlex is an Elixir-based web service that provides a simple HTTP request and response service. It is inspired from [httpbin](https://httpbin.org/) and helps developers test and debug HTTP requests.
44

55
## Features
6+
67
The project is built using Elixir and the Phoenix framework. It defines a controller (`HTTPlexWeb.APIController`) that handles various HTTP endpoints:
78

89
HTTP Methods:
10+
911
- `index/2`: Welcome message
1012
- `get/2`, `post/2`, `put/2`, `patch/2`, `delete/2`: Return request info for respective HTTP methods
1113
- `anything/2`: Accepts and returns data for any HTTP method
1214

1315
Request Inspection:
16+
1417
- `ip/2`: Returns the client's IP address
1518
- `user_agent/2`: Returns the user-agent header
1619
- `headers/2`: Returns all request headers
1720

1821
Response Inspection:
22+
1923
- `response_headers/2`: Sets custom response headers
2024

2125
Auth:
26+
2227
- `basic_auth/2`, `hidden_basic_auth/2`: Test Basic Authentication (hidden version doesn't send WWW-Authenticate header)
2328
- `bearer/2`: Tests Bearer Token Authentication
2429
- `digest_auth/2`: Tests Digest Authentication
2530

2631
Status codes:
32+
2733
- `status/2`: Returns response with specified status code
2834

2935
Request formats:
36+
3037
- `forms_post/2`: Handles form data submission
3138

3239
Response formats:
40+
3341
- `html_response/2`: Returns an HTML response
3442
- `json_response/2`: Returns a JSON response
3543
- `xml/2`: Returns an XML response
3644
- `image/2`: Returns an image in specified format
3745

3846
Redirects:
47+
3948
- `absolute_redirect/2`: Performs absolute redirects
4049
- `redirect_to/2`: Redirects to specified URL
4150
- `redirectx/2`: Performs multiple redirects
4251
- `relative_redirect/2`: Performs relative redirects
4352

4453
Dynamic data:
54+
4555
- `uuid/2`: Generates and returns a UUID
4656
- `random_bytes/2`: Returns random bytes
4757
- `deny/2`: Simulates denied access by robots.txt
@@ -54,17 +64,20 @@ Dynamic data:
5464
- `stream_json/2`: Streams JSON data
5565

5666
Cookies:
67+
5768
- `get_cookies/2`: Returns all cookies sent with the request
5869
- `set_cookies/2`, `set_cookie/2`: Set multiple or a single cookie
5970
- `delete_cookies/2`: Deletes specified cookies
6071

6172
Encoding:
73+
6274
- `brotli/2`: Returns Brotli-encoded data
6375
- `deflate/2`: Returns Deflate-encoded data
6476
- `gzip/2`: Returns GZip-encoded data
6577
- `encoding_utf8/2`: Returns UTF-8 encoded text
6678

6779
Caching:
80+
6881
- `cache/2`: Tests caching headers
6982
- `cache_control/2`: Sets Cache-Control header with specified max-age
7083
- `etag/2`: Tests ETag functionality
@@ -76,6 +89,7 @@ Each function or group of functions corresponds to different features or test sc
7689
To use HTTPlex, send HTTP requests to the appropriate endpoints. The service will respond with JSON data (in most cases) containing the requested information or performing the specified action.
7790

7891
For example:
92+
7993
- `GET /ip` will return your IP address.
8094
- `POST /post` with some data will echo back information about your POST request.
8195
- `GET /status/404` will respond with a 404 status code.
@@ -86,8 +100,8 @@ This service is particularly useful for testing HTTP clients, debugging web appl
86100

87101
To start your Phoenix server:
88102

89-
* Run `mix setup` to install and setup dependencies
90-
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
103+
- Run `mix setup` to install and setup dependencies
104+
- Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
91105

92106
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
93107

@@ -99,15 +113,16 @@ The theme is available as open source under the terms of the [MIT License](https
99113

100114
## Contributing
101115

102-
Bug reports and pull requests are welcome on GitHub at https://github.com/abhinavs/httplex.
116+
Bug reports and pull requests are welcome on GitHub at <https://github.com/abhinavs/httplex>.
103117

104118
## Other Projects
105119

106120
If you like HTTPlex, do check out my other projects
107-
* [soopr](https://www.soopr.co) - a tool that supports you in content marketing
108-
* [ping](https://www.apicblocks.com/ping) - monitor your websites's uptime
109-
* [annexr](https://www.annexr.com) - chat based search for your website.
110-
* [apicagent](https://www.apicagent.com) - a FREE API that extracts device details from user-agent string
111121

122+
- [soopr](https://www.soopr.co) - a tool that supports you in content marketing
123+
- [ping](https://www.apicblocks.com/ping) - monitor your websites's uptime
124+
- [annexr](https://www.annexr.com) - chat based search for your website.
125+
- [apicagent](https://www.apicagent.com) - a FREE API that extracts device details from user-agent string
126+
- [cookie](https://github.com/abhinavs/cookie) - an open source landing website with supporting pages and integrated blog
112127

113-
✨⚡You can read more about me on my [blog](https://www.abhinav.co/about/) or follow me on Twitter - [@abhinav](https://twitter.com/abhinav)
128+
✨⚡You can read more about me on my [blog](https://www.abhinav.co/about/) or follow me on Twitter - [@abhinav](https://twitter.com/abhinav)

0 commit comments

Comments
 (0)