Catalog/dev-openapi-lint

Developer

OpenAPI/Swagger spec linter & quality score API

Lints an OpenAPI/Swagger spec for documentation quality: missing API title/version/description, operations lacking operationId, duplicate operationIds, operations with no summary/description, and operations with no responses defined. Returns categorized issues (error/warning), per-rule locations, coverage stats, and a 0-100 quality score with an A-F grade. Answers 'how well documented is this API', 'what's wrong with this OpenAPI spec', 'grade this API design'.

Price$0.01per request
MethodPOST
Route/v1/dev/openapi-lint
StatusLive
MIME typeapplication/json
Rate limit60/minute
Cache86400s public
devopenapiswaggerlintqualityapispecscore
API URLhttps://x402.hexl.dev/v1/dev/openapi-lint
Integration docs
Example request
{
  "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json"
}
Example response
{
  "specVersion": "3.0.4",
  "operationCount": 19,
  "issueCount": 0,
  "errors": 0,
  "warnings": 0,
  "qualityScore": 100,
  "grade": "A",
  "coverage": {
    "operationsWithId": 19,
    "operationsWithSummary": 19
  },
  "issues": [],
  "specUrl": "https://petstore3.swagger.io/api/v3/openapi.json"
}
Input schema
{
  "type": "object",
  "required": [
    "specUrl"
  ],
  "properties": {
    "specUrl": {
      "type": "string",
      "description": "Full http(s) URL to an OpenAPI/Swagger JSON spec."
    }
  }
}
Output schema
{
  "type": "object",
  "additionalProperties": true
}