Linting Rules - Swagger V2 - Security API Key

Number of APIs: 1

This is a Spectral governance rule to enforce that API key security is applied to the 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-security-api-key": {
    "description": "Requires the usage of an API key for security.",
    "message": "Must add security definition object with type of apiKey",
    "severity": "error",
    "given": "$.security.*",
    "then": {
      "field": "type",
      "function": "enumeration",
      "functionOptions": {
        "values": [
          "apiKey"
        ]
      }
    }
  }
}

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. Swagger V2 - Security API Key POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/swagger-v2-security-api-key/