Linting Rules - OpenAPI V3 Security Scheme API Key

Number of APIs: 1

This is a Spectral governance rule to enforce that API key security is applied to the 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-security-scheme-api-key": {
    "description": "Requires the usage of API key for security scheme.",
    "message": "Must add API key for security scheme.",
    "given": "$.components.securitySchemes[Keys.ClientId]",
    "severity": "error",
    "then": [
      {
        "field": "type",
        "function": "pattern",
        "functionOptions": {
          "match": "^apiKey$"
        }
      },
      {
        "field": "in",
        "function": "pattern",
        "functionOptions": {
          "match": "^header$"
        }
      },
      {
        "field": "name",
        "function": "pattern",
        "functionOptions": {
          "match": "^X-api-key$"
        }
      }
    ]
  }
}

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 Security Scheme API Key POST {{baseUrl}}/linter?rulesUrl=https://rules.linting.org/rules/openapi-v3-security-scheme-api-key/