curl/README.md
vlw d9fa939da5 doc(fix): README nit fixes (#1)
Add public domain mark badge as well as some other fixes to README.

Reviewed-on: https://codeberg.org/vlw/curl/pulls/1
Co-authored-by: vlw <victor@vlw.se>
Co-committed-by: vlw <victor@vlw.se>
2025-02-09 10:30:01 +00:00

40 lines
No EOL
1.1 KiB
Markdown

![license](https://licensebuttons.net/p/zero/1.0/88x31.png)
# A simple curl wrapper written in bash that can be used to make HTTP requests to API endpoints.
![screenshot](https://href.vlw.se/0194ea19-faa6-77b5-8fe1-b1459a12ea84)
I use this script with windows set up like this in code-server.
# Files
This script uses separate files for various request options. Create these files in the same directory as `curl.sh`.
## `params.txt`
URL search parameters.
## `paylaod.json`
JSON request body that will be sent with all requests (except `GET`).
## `key.txt`
[HTTP Authentication Bearer Token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)
## `disable_peer_validation`
Optional empty file that when present will disable SSL peer validation - for self-signed certificates etc.
# Make a request
Run the `curl.sh` file from your shell and pass it two parametes for URL and request method.
```sh
./curl.sh https://example.com GET
```
The response body will be printed to stdout.
*Example*
```
vlw@example:/curl$ ./curl.sh https://example.com GET
GET https://example.com?foo=bar
"This is an example response body in plaintext"
vlw@example:/curl$
```