Anypoint Best Practices
path-keys-no-trailing-slash
general > path-keys-no-trailing-slash
Guidance
Keep trailing slashes off of paths, as it can cause some confusion. Some web tooling (like mock servers, real
servers, code generators, application frameworks, etc.) will treat example.com/foo and example.com/foo/ as the
same thing, but other tooling will not. Avoid any confusion by just documenting them without the slash, and maybe
some tooling will let people shove a / on there when they're using it or maybe not, but at least the docs are
suggesting how it should be done properly.
Message
Path keys should not end with a trailing slash. '{{apiContract.path}}' is invalid.
Examples
valid
#%RAML 1.0
title: example api
version: 1.0.0
/events:
invalid
#%RAML 1.0
title: example api
version: 1.0.0
/events/:
Applies to EndPoint