Skip to content

Commit e7e0f38

Browse files
committed
updated httpyac example and amended clients page
1 parent 2f0eaec commit e7e0f38

File tree

3 files changed

+39
-19
lines changed

3 files changed

+39
-19
lines changed

challenger/src/main/resources/content/changes.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ showads: true
66

77
# Change Log
88

9-
## 2025/0419 - Bruno Client Demo
9+
10+
## 2025/04/20
11+
12+
Updated the [API Clients Page](/tools/clients):
13+
14+
- Removed Thunder Client due to the licensing changes and restriction of functionality in the free version.
15+
- Removed Advanced Rest Client when re-evaluating I could not get it to open an Open API file, and it has now been superseded by other API Clients.
16+
- Added a link to [Open Source APi Clients list](https://github.com/stepci/awesome-api-clients)
17+
18+
## 2025/04/19 - Bruno Client Demo
1019

1120
- Added video overview of the [Bruno Client](/tools/clients/bruno)
1221

challenger/src/main/resources/content/tools/clients.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ For exploratory testing, I would use one of the listed tools.
2222

2323
I have used all of the following tools.
2424

25-
At the moment I primarily use [Bruno](https://www.usebruno.com/) or [Thunderclient](https://www.thunderclient.com/) for my exploratory testing. I configure it to feed all traffic through the [BurpSuite](https://portswigger.net/burp/communitydownload) proxy to capture all my traffic and allow me to save and review my testing.
25+
At the moment I use [Bruno](https://www.usebruno.com/) for my exploratory testing. I configure it to feed all traffic through the [BurpSuite](https://portswigger.net/burp/communitydownload) proxy to capture all my traffic and allow me to save and review my testing.
2626

2727
### Command Line Clients
2828

@@ -36,20 +36,29 @@ At the moment I primarily use [Bruno](https://www.usebruno.com/) or [Thunderclie
3636

3737
### GUI Clients
3838

39+
I recommend Bruno. It is a very capable free client, with paid plans if you want to use the tool for automated execution.
40+
3941
- [Bruno](https://www.usebruno.com/)
4042
- An [open source](https://github.com/usebruno/bruno) REST Client which can import Swagger files and is easy to configure.
4143
- [Read our More Detailed Review of Bruno](/tools/clients/bruno)
42-
- [Advanced REST Client](https://www.advancedrestclient.com/home)
43-
- An electron based [open source client](https://github.com/advanced-rest-client/arc-electron), not updated often
44+
45+
A list of Open Source API Clients is available at the [Awesome API Clients Github list](https://github.com/stepci/awesome-api-clients). This is a well maintained and up to date list containing more clients than are listed here.
46+
4447
- [Paw (Mac only)](https://paw.cloud/)
4548
- Free Mac only REST Client. A previously commercial REST Client which was good enough for me to buy a license.
49+
50+
### Other Popular clients
51+
52+
The tools listed here are often used for testing.
53+
54+
I have used Postman and Insomnia, but both have now expanded their feature set such that they are suites of API tooling and are not as simple to use for exploratory testing as they once were.
55+
4656
- [Postman](https://www.getpostman.com/)
4757
- A commercial REST Client with Free version for personal use, requires a free account and login to use effectively
4858
- [Insomnia](https://insomnia.rest/)
4959
- Another commercial REST Client with Free version for personal use, which also requires a free account and login to use effectively
5060

51-
52-
GUI Clients which I have not yet used:
61+
GUI Clients which I have not yet used, but are often mentioned by Software Testers. They may be more feature packed than required for exploratory testing.
5362

5463
- [Katalon Studio](https://katalon.com/katalon-studio)
5564
- [SoapUI Open Source](https://www.soapui.org)
@@ -67,12 +76,6 @@ But they are very useful to experiment with an API quickly.
6776
- [RestTestTest](https://resttesttest.com/)
6877
- This is a very basic online client. Recommend using the Developer Tool Network tab to view the requests and responses.
6978

70-
### IDE Extensions
71-
72-
VS Code:
73-
74-
- [Thunderclient](https://www.thunderclient.com/)
75-
7679

7780
## Features Useful For Testing
7881

@@ -145,4 +148,5 @@ Scriptable needs to be easy to use and I mainly use it to support me, rather tha
145148

146149
Testing requires variation, observation and exploration, so we need tools that can help us send requests, easily vary requests and inspect the responses to find problems.
147150

148-
Automating helps us identify unanticipated changes in behaviour that we previously asserted as acceptable.
151+
Automating helps us identify unanticipated changes in behaviour that we previously asserted as acceptable.
152+

docs/httpyac/httpyacexample.http

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,23 @@ But adding the ### to separate requests and documentation seems to work well eno
2424

2525
@host=https://apichallenges.eviltester.com
2626

27-
### @Description Example call to GET https://apichallenges.eviltester.com/todos because it uses the @host
27+
/*
28+
** Enable to allow all requests to go through a proxy **
29+
30+
to get proxy to work, make sure the "Proxy Support" is set to on
31+
in VS Code Preferences > Settings
32+
'override' doesn't seem to work
33+
*/
34+
// # @proxy http://127.0.0.1:8080
2835

36+
### @Description Example call to GET https://apichallenges.eviltester.com/todos because it uses the @host
2937
GET /todos
3038

3139
###
3240

3341
## Create a Session
3442

35-
We can create a session in the challenges by issuing a `POST` request.
43+
We can create a session in the challenges by issuing a request.
3644

3745
To see the console.info:
3846

@@ -71,7 +79,9 @@ POST /challenger
7179

7280
## TODOs
7381

74-
To get the list of todos from the environment we can issue a `GET` request on the `/todos` endpoint.
82+
To get the list of todos from the environment we can issue a request on the `/todos` endpoint.
83+
84+
The `@name` will show the response as a variable in HTTPYAC extension view.
7585

7686
###
7787
# @name get_all_todos
@@ -148,12 +158,9 @@ x-challenger: {{xChallenger}}
148158

149159

150160
###
151-
# @proxy http://127.0.0.1:8080
152161
# @Description Delete all todos
153162
# @forceref get_all_todos
154163
# @loop for id of allTodoIds
155164

156165
DELETE /todos/{{id}}
157166
x-challenger: {{xChallenger}}
158-
159-
/* have not managed to get proxy working or forceref */

0 commit comments

Comments
 (0)