{"id":15286662,"url":"https://github.com/nickheap2/newman-reporter-openapi","last_synced_at":"2026-03-17T09:40:40.993Z","repository":{"id":65457181,"uuid":"430162010","full_name":"NickHeap2/newman-reporter-openapi","owner":"NickHeap2","description":"Newman reporter for openapi specs to show coverage","archived":false,"fork":false,"pushed_at":"2022-05-12T23:11:07.000Z","size":305,"stargazers_count":11,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-26T20:49:33.282Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/newman-reporter-openapi","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/NickHeap2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-11-20T17:07:45.000Z","updated_at":"2024-05-13T18:28:49.000Z","dependencies_parsed_at":"2023-01-24T12:15:17.932Z","dependency_job_id":null,"html_url":"https://github.com/NickHeap2/newman-reporter-openapi","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickHeap2%2Fnewman-reporter-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickHeap2%2Fnewman-reporter-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickHeap2%2Fnewman-reporter-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/NickHeap2%2Fnewman-reporter-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/NickHeap2","download_url":"https://codeload.github.com/NickHeap2/newman-reporter-openapi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248659766,"owners_count":21141175,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-30T15:17:55.653Z","updated_at":"2026-03-17T09:40:40.944Z","avatar_url":"https://github.com/NickHeap2.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# newman-reporter-openapi\n## Newman reporter for openapi spec coverage\n---\n\nThis is a Newman OpenAPI reporter for generating coverage reports from a Newman run based on an OpenAPI specification.\n\nIt 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.\n\nIt determines coverage as how much of the path/method/response tree has requests made during the run.\n\n```\n├── path\n|   └── method\n|       ├── response\n|       ├── response\n|       └── response\n└── path\n    └── method\n        ├── response\n        └── response\n```\n\nIt produces output like this:\n![wide](https://github.com/NickHeap2/newman-reporter-openapi/blob/367b9daf8710e8e1f3f4b614604a27fecac7eaab/images/wide_report.png)\n\n### Install the reporter\n---\n```console\nnpm install newman-reporter-openapi\nor\nnpm install -g newman-reporter-openapi\n```\n\n### Reporter options\n---\n\nAdd the report as a custom Newman reporter:\n```console\nnewman --reporters openapi\n```\n\nYou can include multiple Newman reporters like this:\n```console\nnewman --reporters \"cli,openapi\"\n```\n\nThe only required parameter for the OpenAPI reporter is the OpenAPI spec using --reporter-openapi-spec:\n```console\n--reporter-openapi-spec ./openapi.yaml\n```\n\nThe reporter will check each Newman API call against the server list in your OpenAPI spec.\n\nIf the server isn't in that list, for local testing for example, you can specify it via --reporter-openapi-serverUrl\n```console\n--reporter-openapi-serverUrl http://127.0.0.1/3000\n```\n\nThe reporter has three different report styles with different layouts. The default is wide.\n\n```console\n--reporter-openapi-reportstyle wide\n--reporter-openapi-reportstyle tall\n--reporter-openapi-reportstyle summary\n```\n\nComing soon --exportFilename for a json based export of the coverage.\n\n### Report symbols\n---\n\nIn the reports the response codes have the following symbols:\n  * \\+ shows a response that was received\n  * \\- shows a response that was not received\n  * \\? shows a received response that was not part of the spec\n\n### Report styles\n---\n\nThere are three different versions of the report.\n\nwide - best for when your spec has many different paths (the default)\n![wide](https://github.com/NickHeap2/newman-reporter-openapi/blob/367b9daf8710e8e1f3f4b614604a27fecac7eaab/images/wide_report.png)\n\ntall - an option for APIs with a small number of paths otherwise it can get too tall\n![tall](https://github.com/NickHeap2/newman-reporter-openapi/blob/2a95a92573fb1678fa03594f52c9648b1bc1921a/images/tall_report.png)\n\nsummary - for a basic summary of the coverage without path or response details\n![summary](https://github.com/NickHeap2/newman-reporter-openapi/blob/367b9daf8710e8e1f3f4b614604a27fecac7eaab/images/summary_report.png)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickheap2%2Fnewman-reporter-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnickheap2%2Fnewman-reporter-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnickheap2%2Fnewman-reporter-openapi/lists"}