Skip to main content

plugin tool for capturing API coverage with input of a SPEC file against API shark of CloudVector

Project description

CV-APIAnalyser

cvapianalyser is a Python library for analysing the api traffic captured by CloudVector's APIShark against an APISPEC for identifying the gap in API coverage mostly useful in a QA environment to understand the gap in test coverage.

Visit https://www.cloudvector.com/api-shark-free-observability-security-monitoring-tool/#apishark

Installation

Use the package manager pip to install foobar.

pip install cvapianalyser

Usage

cvapianalyser 

****************************************************************************************************
CloudVector CommunityEdition - Coverage analysis plugin
****************************************************************************************************

Enter CommunityEdition(CE) host in format <host>:<port> : x.x.x.x:y
Enter your CommunityEdition(CE) username : sandeep
CommunityEdition(CE) password:
Enter recording in CE to compare with : recording1

instead of giving inputs every single time you can also alternatively create a file called my_cesetup.yaml in the path from where you are running the tool

ce_host:
ce_username:
ce_recording:
input_apispec:

you can have multiple such my_cesetup.yaml for different CE setup or different recordings and run them from specific paths for its corresponding reports

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cvapianalyser-1.0.0.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

cvapianalyser-1.0.0-py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page