Documentation
Learn how to use REST Lens and understand API evaluation rules
Evaluation Rules
Comprehensive guide to all 25+ API design rules
Learn about URI design, HTTP methods, status codes, headers, and more
Custom Rules
Create organization-specific rules
Define your own rules in YAML or import existing Spectral rulesets
API Integration
CI/CD integration and API token usage
Integrate REST Lens into your CI/CD pipeline with GitHub Actions, GitLab CI, Jenkins, and more
MCP Integration
Model Context Protocol server
Connect MCP-compatible AI assistants to REST Lens for natural language API evaluation
CLI
Command-line interface
Evaluate API specifications from your terminal with the REST Lens CLI
IDE Integration
VS Code extension
Real-time API evaluation directly in your editor with inline diagnostics
Getting Started
Quick start guide and tutorials
Create accounts, upload specs, review results, and configure rules for your team
REST Lens for Research
Free access for academic research
Higher rate limits, bulk evaluation, and controlled dashboard access for research projects