Anypoint Best Practices

api-must-have-documentation

general > api-must-have-documentation


Guidance / Message

Provide the documentation for the API.

Examples

valid

#%RAML 1.0
title: example api
version: 1.0.0
documentation:
- title:  Some title
  content: |
    Welcome to the API Documentation.

invalid

#%RAML 1.0
title: example api

Applies to WebAPI

Constraint

Type: Declarative Validation
TypeRuleset
OrganizationMuleSoft
Published by
Mulesoft Organization
Published onOct 26, 2026
Asset overview

Asset versions for 1.7.x

Asset versions
VersionActions
1.7.0

Tags