blob: a47d00debca3dcd5d3cba7c130ee63de521c252b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
BARB
====
Barb is a file-based API query tool that works nicely with version control and fits into UNIX terminal usage.
## Example usage
```
barb <file 1> <file 2> ... <file n>
```
### CLI options
- `-a, --all-headers`: Print all headers, request and response
- `-b, --body`: Only print the response body
- `-h, --headers`: Only print the response headers
- `-r, --raw`: Don't format the response body
- `-V, --version`: Print the software version
## Barb format
Barb uses a custom file format to perform requests. Each file contains _one_ request and is started by a request preamble. Example:
```
#POST^http://my-blog.com/posts
#Authorization: TOKEN {API_TOKEN}
{
"title": "A post",
"content": "My pretty blog post"
}
```
The preamble contains the directives relevant to performing the request, such as the method, URL and headers. The preamble _must end with an empty line_.
### Verb line
The verb line indicates to _barb_ what sort of request to perform and where to. It follows this rigid format:
```
#<METHOD>^<URL>
```
The `URL` supports variable substitution, but `METHOD` does not.
Supported methods are:
- GET
- POST
- PUT
- DELETE
- PATCH
### Headers
Headers are formatted as follows:
```
#<HEADER NAME>: <HEADER VALUE>
```
The `HEADER VALUE` supports variable substitution, `HEADER NAME` does not.
There can be none or many headers.
### Filter
!!! Not operational at this time
Barb will support JQ filtering of the response body. This has the following format:
```
#|<JQ FILTER>
```
The `JQ FILTER` supports variable substitution.
### Body
Anything after the preamble is considered as a body and will be send in the request for the following methods:
- PUT
- POST
- PATCH
Body does not support variable substitution.
### Variable substitution
Barb can include environment variable values into the requests with the following placeholder format:
```
{VARIABLE NAME}
```
Which allows to do the following:
```
$ export BASE_URL="http://127.0.0.1:8000"
$ cat api-status.barb
#GET^{BASE_URL}/api/v1/status
$ barb api-status.barb
200 OK GET http://127.0.0.1:8000/api/v1/status
{
"status": "OK"
}
```
## Credits
- Code: [Guillaume Pasquet](https://gitlab.com/guillaume54/)
- Logo: [Harpoon Chain Icon](https://game-icons.net/1x1/lorc/harpoon-chain.html) by Lorc under CC By 3.0
|
