Anypoint Best Practices

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