Anypoint Best Practices

provide-examples

general > provide-examples


Guidance / Message

Always include examples in requests and responses.

Examples

valid

responses:
  200:
    description: Ok!
    body:
      application/json:
        type: string
        example: Hello!

invalid

responses:
  200:
    description: Ok!
    body:
      application/json:
        type: string # no example here

Applies to Payload

Constraint

Type: Rego 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