Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
newman-reporter-openapi
Advanced tools
Readme
This is a Newman OpenAPI reporter for generating coverage reports from a Newman run based on an OpenAPI specification.
It was inspired by the openapi-backend projects route matching and a desire to see how much of the OpenAPI spec automated test generators were producing.
It determines coverage as how much of the path/method/response tree has requests made during the run.
├── path
| └── method
| ├── response
| ├── response
| └── response
└── path
└── method
├── response
└── response
It produces output like this:
npm install newman-reporter-openapi
or
npm install -g newman-reporter-openapi
Add the report as a custom Newman reporter:
newman --reporters openapi
You can include multiple Newman reporters like this:
newman --reporters "cli,openapi"
The only required parameter for the OpenAPI reporter is the OpenAPI spec using --reporter-openapi-spec:
--reporter-openapi-spec ./openapi.yaml
The reporter will check each Newman API call against the server list in your OpenAPI spec.
If the server isn't in that list, for local testing for example, you can specify it via --reporter-openapi-serverUrl
--reporter-openapi-serverUrl http://127.0.0.1/3000
The reporter has three different report styles with different layouts. The default is wide.
--reporter-openapi-reportstyle wide
--reporter-openapi-reportstyle tall
--reporter-openapi-reportstyle summary
Coming soon --exportFilename for a json based export of the coverage.
In the reports the response codes have the following symbols:
There are three different versions of the report.
wide - best for when your spec has many different paths (the default)
tall - an option for APIs with a small number of paths otherwise it can get too tall
summary - for a basic summary of the coverage without path or response details
FAQs
Newman reporter for OpenAPI coverage
The npm package newman-reporter-openapi receives a total of 114 weekly downloads. As such, newman-reporter-openapi popularity was classified as not popular.
We found that newman-reporter-openapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.