Skip to content

Commit e246212

Browse files
committed
Update readme with detailed installation process
1 parent ce7fe11 commit e246212

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,20 +9,34 @@ A simple bash script to test JSON API from terminal in a structured and organize
99
- [curl](https://curl.haxx.se/download.html)
1010
- [jq](https://stedolan.github.io/jq/download)
1111

12+
In cloud 9 / CentOs / aws linux image
13+
14+
```sh
15+
sudo yum install jq
16+
```
17+
1218
## Installing
1319

20+
Pull the script
21+
1422
```sh
1523
curl -LJO https://raw.githubusercontent.com/subeshb1/api-test/master/api-test.sh
1624
```
1725

26+
Make the script executable
27+
1828
```sh
1929
chmod +x api-test.sh
2030
```
2131

32+
Move it to `/usr/local/bin` to make it executable from anywhere
33+
2234
```
23-
mv api-test.sh /usr/local/bin/api-test
35+
sudo mv api-test.sh /usr/local/bin/api-test
2436
```
2537

38+
Check if the installation is successful
39+
2640
```
2741
api-test --help
2842
```
@@ -90,13 +104,19 @@ Example:
90104
},
91105
"url": "localhost:3000",
92106
"header": {
93-
"Authorization": "Bearer <ACCESS_TOKEN>"
107+
"Authorization": "Bearer <ACCESS_TOKEN>"
94108
}
95109
}
96110
```
97111

98112
The test cases are present in the `testCases` object. The main url for the api is store in `url` string. If the test cases share common headers add them in root `header` key.
99113

114+
To pull the `template.json`
115+
116+
```
117+
curl -LJO https://raw.githubusercontent.com/subeshb1/api-test/master/template.json
118+
```
119+
100120
### Running test case
101121

102122
```

0 commit comments

Comments
 (0)