Support to calculate the uncovered APIs
LinuxSuRen opened this issue · comments
Having a better API testing coverage source is expected. But how do we know if there are some APIs are uncovered? I believe this is an important question for the testing tool.
Let's assume some APIs have a fixed pattern or a standard. For instance, some applications could generate the JSON schema of Swagger or OpenAPI. So, I'm thinking if we could calculate the diff between the branches in a PR. Then we could tell developers which APIs are uncovered against the target branch.
How to use it?
For the CI/CD user cases, it's better to have a sub-command to do it. Below are some possible usages:
atest api diff --source source.json --target target.json --spec (swagger|openapi) --missing-action [error|warning]
Don't do
This function should focus on itself. We can discuss it, but please see also the following ideas:
- Assume users could get the correct JSON files
This issue has been open 30 days with no activity. This will be closed in 7 days.
This issue has been automatically marked as stale because it hasn't had any recent activity.If you think this should still be open, or the problem still persists, just pop a reply in the comments and one of the maintainers will (try!) to follow up. Thank you for your interest and contribution to the api-testing.