APIReaper
Overview
APIReaper is a simple tool to assess an API and its answer.
Description
This tool validate if an API is able to reply to an incoming request and check if the data structure sent back is valid. It requires a valid schema to compare the data against.
Setup
$ gem install apireaper
Usage
An interactive help is available with:
$ apireaper help
Examples
To check an API:
$ apireaper check POST "<API_URL>" -h "<HEADER_KEY>:<HEADER_VALUE>" \
-d "<DATA_KEY>=<DATA_VALUE>" -S '<JSON_SCHEMA_OBJECT_AS_STRING>'
To check an API with a schema in a file:
$ apireaper check POST "<API_URL>" -h "<HEADER_KEY>:<HEADER_VALUE>" \
-d "<DATA_KEY>=<DATA_VALUE>" -F '<PATH_TO_JSON_SCHEMA_FILE>'
Limitations
It is currently only available to validate JSON data structure. More data structure may be available later.
Development
Please read carefully CONTRIBUTING.md before making a merge request.
╚⊙ ⊙╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝
╚═(███)═╝