Linting Rules - OpenAPI V3 - Do Not Use API for Base Path

Number of APIs: 1

This is a Spectral governance rule to make sure that /api is not used as base path in an OpenAPI. 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.

{
  "openapi-v3-do-not-use-api-for-base-path": {
    "description": "Ensures that paths do not use /api as part of the base path.",
    "message": "You should not use /api as part of your base path.",
    "severity": "warn",
    "given": "$.paths.*~",
    "then": {
      "function": "pattern",
      "functionOptions": {
        "notMatch": "^/api"
      }
    }
  }
}

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.

1. OpenAPI V3 - Do Not Use API for Base Path POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-do-not-use-api-for-base-path/