Skip to content

Commit

Permalink
added labels and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
dreamquality committed Jan 19, 2025
1 parent b9aa123 commit 0d56521
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 2 deletions.
File renamed without changes.
Binary file added assets/main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "A Node.js CLI tool to measure test coverage of Swagger/OpenAPI specs using Postman collections.",
"main": "cli.js",
"bin": {
"swagger-coverage-cli": "./cli.js"
"swagger-coverage-cli": "cli.js"
},
"scripts": {
"test": "jest"
Expand All @@ -21,7 +21,7 @@
"license": "ISC",
"repository": {
"type": "git",
"url": "https://github.com/dreamquality/swagger-coverage-cli.git"
"url": "git+https://github.com/dreamquality/swagger-coverage-cli.git"
},
"bugs": {
"url": "https://github.com/dreamquality/swagger-coverage-cli/issues"
Expand All @@ -38,5 +38,9 @@
},
"engines": {
"node": ">=14"
},
"directories": {
"lib": "lib",
"test": "test"
}
}
6 changes: 6 additions & 0 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
![npm](https://img.shields.io/npm/v/swagger-coverage-cli?color=blue&label=npm&logo=npm)
![Tests](https://github.com/dreamquality/swagger-coverage-cli/actions/workflows/test.yml/badge.svg)

# Swagger Coverage CLI

> **A command-line utility to compare your OpenAPI/Swagger specification with a Postman collection and calculate **API test coverage**. Generates a human-readable HTML report.**
Expand Down Expand Up @@ -138,6 +141,9 @@ Unmatched operations:
- A file named `coverage-report.html` (or the name you provided with `--output`) is generated.
- Open it in your browser to see a table of matched/unmatched operations with color highlights.

![main](https://github.com/dreamquality/swagger-coverage-cli/blob/main/assets/main.png?raw=true)
![table](https://github.com/dreamquality/swagger-coverage-cli/blob/main/assets/table.png?raw=true)

---

## Detailed Matching Logic
Expand Down

0 comments on commit 0d56521

Please sign in to comment.