mirror of
https://codeberg.org/vlw/curl.git
synced 2025-09-13 16:23:41 +02:00
doc(feat): add header.json to README
This commit is contained in:
parent
806e465ea2
commit
3137ea3137
1 changed files with 24 additions and 7 deletions
31
README.md
31
README.md
|
@ -1,22 +1,39 @@
|
||||||

|

|
||||||
|
|
||||||
# A simple curl wrapper written in bash that can be used to make HTTP requests to API endpoints.
|
# Simple curl bash wrapper
|
||||||
|
|
||||||

|
<img src="https://blob.vlw.se/01/0199056d-d6fc-748b-adbb-269c8c5237ab.png">
|
||||||
|
|
||||||
I use this script with windows set up like this in code-server.
|
---
|
||||||
|
|
||||||
|
**This is a very simple wrapper for curl that I use with VSCode (code-server) to make HTTP requests - like Postman but super simple.**
|
||||||
|
|
||||||
|
VSCode is not required to run this script, I use it as a GUI.
|
||||||
|
|
||||||
# Files
|
# Files
|
||||||
This script uses separate files for various request options. Create these files in the same directory as `curl.sh`.
|
This script uses separate files for various request options. Create these files in the same directory as `curl.sh`.
|
||||||
|
|
||||||
## `params.txt`
|
## `params.txt`
|
||||||
URL search parameters.
|
URL search parameters. (Leading "?" is optional)
|
||||||
|
```
|
||||||
|
foo=bar&hello=world
|
||||||
|
```
|
||||||
|
|
||||||
## `paylaod.json`
|
## `payload.json`
|
||||||
JSON request body that will be sent with all requests (except `GET`).
|
JSON request body that will be sent with all requests (except `GET`).
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"request_body_parameter": "request_body_value"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## `key.txt`
|
## `headers.json`
|
||||||
[HTTP Authentication Bearer Token](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication)
|
Key-value JSON object of optional request headers.
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"X-Header-Name": "Header value"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
## `disable_peer_validation`
|
## `disable_peer_validation`
|
||||||
Optional empty file that when present will disable SSL peer validation - for self-signed certificates etc.
|
Optional empty file that when present will disable SSL peer validation - for self-signed certificates etc.
|
||||||
|
|
Loading…
Add table
Reference in a new issue