Linting Rules - Swagger V2 - Limit Number of Sub-resources
Number of APIs: 1
This is a Spectral governance rule to make sure that there aren't too many sub-resources in an Swagger. Here is a JSON version of the rule that can be applied using this API-driven collection API, or at CLI or CI/CD pipeline.
{
"swagger-v2-limit-number-of-sub-resources": {
"description": "Ensures that there are not too many sub-resources.",
"message": "There should be no more than three levels of sub-resources.",
"severity": "warn",
"given": "$.paths.*~",
"then": {
"function": "pattern",
"functionOptions": {
"match": "^/[^/]*((/{[^}]*})*/[^/]*(/{[^}]*})*){0,3}/?$"
}
}
}
}
This request can be run as part of this collection, or dragged and dropped to another collection of governance requests organized by folder, demonstrating how API governance linting works, but also providing a rule that can be used as part of your wider API governance strategy.
- Swagger V2 - Limit Number of Sub-resources POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-limit-number-of-sub-resources/