Articles
Author
vacuum
Quick Start
💥 Try It Now
About vacuum
Installing
Why?
Concepts
Agent Testing
About
Suites
Evidence
Results
FAQ
AsyncAPI
Arazzo
Ignoring Violations
JSON Schema
Changelog
Configuring
Generate API Docs
VSCode Plugin
GitHub Action
CLI Commands
Lint
Test
vacuum Report
Dashboard
Generate Docs
HTML Report
Spectral Report
References
Upgrade vacuum
Version
Bundle Spec
Generate RuleSet
Language Server
Apply Overlay
Schema
Open Collection
Change Detection
Exit Codes
Developer API
API Quick Start
Spec Index
RuleResultSet
Loading RuleSet
Custom Go
Custom JS
Non-OpenAPI Files
Test Harness
Functions
Core Functions
OpenAPI Functions
OWASP Functions
JSON Schema Funcs
AsyncAPI Funcs
Arazzo Funcs
Rules
Examples
OWASP
Channels
Operations/Paths
Messages
Schemas
Spec Information
Servers
Validation
Descriptions
Tags
Security
Arazzo
RuleSets
What are they?
Sharing RuleSets
No Rules/Off
OpenAPI Default
Custom RuleSets
OWASP Rules
JavaScript
JSON Schema Rules
AsyncAPI Default
AsyncAPI All Rules
Arazzo Default
Arazzo All Rules
  • GitHub GitHub Repo stars
  • Discord Discord Server
    • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor

    Developer API Documents

    Get started with APIs.`

    Test Harness

    Run the same tests directly from Go.

    Non-OpenAPI Files

    Custom JS

    Loading RuleSet

    Construct using code, or via a file.

    RuleResultSet

    The easiest way to make sence of linting results.

    Custom Go

    API Quick Start

    Download, plug-in and start linting!

    Spec Index

    The reason behind the speed.