Articles
Author
vacuum
Installing
Quick Start
About vacuum
Why?
Concepts
💥 Online Demo
FAQ
Ignoring Violations
Changelog
Configuring
VSCode Plugin
CLI Commands
Lint
vacuum Report
Dashboard
HTML Report
Spectral Report
References
Version
Bundle Spec
Generate RuleSet
Language Server
Developer API
API Quick Start
Spec Index
RuleResultSet
Loading RuleSet
Custom Go Functions
Custom JS Functions
Non-OpenAPI Files
Functions
Core Functions
OpenAPI Functions
OWASP Functions
Rules
Examples
OWASP
Operations/Paths
Schemas
Spec Information
Validation
Descriptions
Tags
Security
RuleSets
What are they?
Sharing RuleSets
No Rules/Off
Recommended Rules
Custom RuleSets
OWASP Rules
  • GitHub GitHub Repo stars
  • Discord Discord Server
    • ✨ New! Try the OpenAPI Doctor ✨ The OpenAPI Doctor
    Recommended

    oas3-api-servers

    Formats: Severity:

    When configuring Servers in OpenAPI, its important to ensure correctness, so tooling can inspect endpoints automatically.

    Mis-configured server configurations will damage automation capabilities for the contract.

    What is this rule checking for?

    • Server definitions exist
    • Contains URL
    • URL is valid
    • URL does not contain a trailing slash

    Why did this violation appear?

    The servers object is missing from the spec, or one of more entries contain an invalid URL.

    Bad example

    servers:
  - url: "I am not a URL"
  - url: "httpWRONG//i-am-not-valid"
  - url: "https://i-end-with-a-slash.com/"

    How do I fix this violation?

    Make sure there are servers definitions and that all the URLs are correct.

    Spectral Equivalent

    The rule is equivalent to oas3-api-servers