A simple cli to test http apis using.

This program is meant to test apis automatically by providing a file with urls and expected status, it will so query all urls and compare what is expected for every case returning it in the console

Warning

Only work with JSON for now, and response comparaison not supported yet

Planned

• Add option to export test cases to excel or other files

Usage

This tools accept a .http file following the Guidelines along with two custom anotations.

Test Names are in the separator, follow this link for more info

Note

I'm placing here references to the http-files documentation, please keep in mind that not all syntax documented there will be applicable here.

Comments are only considered to start with "#" as of now

Anotations

There are two anotations used for the test result comparaison :

• @expect-status <status> -> check for the response status NEEDED IN EACH TEST CASE
• @expect-result <JsonResponse> -> check for the response body, Optional
• @save-cookies -> Save the response cookies
• @use-cookies -> Use the saved response cookies

Example file

### Test 1
GET https://google.com
# @expect-status 200

### Test Post request
POST https://dummyjson.com/posts/add
Content-Type: application/json

{
  "title": "I am in love with someone.", 
  "userId": 5, 
  "body": "Your post content here"
}

# @expect-status 201
# @expect-response {
# "userId":5, 
# "id":252,
# "title":"I am in love with someone.",
# "body":"Your post content here"
# }

### Test login

POST http://sample/api/login
Content-Type: application/json

{
  "username": "test",
  "password": "test"
}

# @expect-status 201
# @save-cookies

### Get all users

GET http://sample/api/users
# @expect-status 200
# @use-cookies

Generic match

For the times a perfect match is not suitable, you can verify by type instead. to do so simply put a string in the field you are trying to check and use one of the following option :

• \\string -> check for string
• \\number -> check for any number (int, float, uint ....)
• \\boolean -> check for any boolean
• \\bool -> alias of \boolean
• \\object -> check for any object
• \\array -> check for any array

Example :

POST https://dummyjson.com/posts/add
Content-Type: application/json

{
  "title": "I am in love with someone.", 
  "userId": 5, 
  "body": "Your post content here"
}

# @expect-status 201
# @expect-response {
# "userId": "\\number", 
# "id":252,
# "title":"\\string",
# "body":"Your post content here"
# }

Notes :

This implementation does not aim to fully cover the cases or the syntax, simply provide a lightweight tester for my own api automated testing. Feel free to fork or open pull requests if you need more functionalities