LukeParke/redocly-cli
1
0
Fork 0
mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 12:47:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
013e91fbf9a1627eb97df19843307bc7063312d4
redocly-cli/docs/rules/no-server-trailing-slash.md
Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334)
2023-11-17 09:45:03 +00:00

1.8 KiB
Raw Blame History

slug
slug
/docs/cli/rules/no-server-trailing-slash

no-server-trailing-slash

Disallow servers with a trailing slash.

OAS Compatibility
2.0 ❌
3.0 ✅
3.1 ✅ 
flowchart TD

root ==> ServersList

style ServersList fill:#codaf9,stroke:#0044d4,stroke-width:5px

API design principles

The endpoint URL is the server URL joined with the path. The path must start with a slash. If the server ends with a slash, there are double slashes. You can get awkward URLs like https://example.com/api//pets.

This rule helps prevent such issues. Servers should not end with a trailing slash. Hands-down a good rule for every API designer.

Configuration

Option Type Description
severity string Possible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  no-server-trailing-slash: error

Examples

Given this configuration:

rules:
  no-server-trailing-slash: error

Example of incorrect server:

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

Example of correct server:

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

Related rules

Resources