API Genie

This rule warns if an OpenAPI schema does not define any server.

Rule Details

The servers-defined rule is designed to ensure that an OpenAPI schema defines at least one server. Not defining servers effectively disables the live documentation feature, where potential users can try to call an API server.

Configuration

None.

Examples

Good.

servers:
    - url: https://api.dev.example.com/v1
        description: Development server

Bad.

# No servers defined

When Not to Use It

We recommend to always enable this rule.

Compatibility

This rule is compatible with all OpenAPI 3.x versions.