Skip to content
Last updated

no-server-example.com

Prevents using example.com as the value of the servers.url fields in your API descriptions. The rule checks for all URL schemes (http, https...).

OASCompatibility
2.0❌
3.0✅
3.1✅
3.2✅
Root
ServersList

API design principles

Although commonly used in different kinds of documentation, example.com is not a real API server. Your consumers cannot use it to test your APIs. Be helpful - give them something they can use.

If you can't reveal a production server, consider a Redocly mock server instead.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default warn (in recommended configuration).

An example configuration:

rules:
  no-server-example.com: error

Examples

Given this configuration:

rules:
  no-server-example.com: error

Example of incorrect server:

servers:
  - url: https://example.com
    description: Example server

Example of correct server:

servers:
  - url: https://swift-squirrel.remockly.com
    description: Mock server

Resources

 
Next page