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...).

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.

An example configuration:

rules:
  no-server-example.com: error

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

• no-empty-servers
• no-server-trailing-slash

• Rule source
• Servers list docs