Anypoint Best Practices

Anypoint Best Practices

This ruleset contains over 30 best practices for APIs to be used, maintained, and consumed across Anypoint Platform and beyond.

Rules in this Ruleset

Violations

• resource-use-lowercase
• media-type-headers-response
• base-url-pattern-server
• camel-case-fields
• date-time-representation
• use-schemas-responses
• use-schemas-requests
• provide-examples
• api-must-have-title
• operations-must-have-identifiers
• no-2xx-response
• path-params
• no-eval-in-markdown
• no-script-tags-in-markdown
• path-declarations-must-exist
• path-not-include-query
• duplicated-entry-in-enum

Warnings

• api-must-have-description
• api-must-have-documentation
• operations-must-have-descriptions
• responses-must-have-descriptions
• headers-must-have-descriptions
• query-params-must-have-descriptions
• property-shape-ranges-must-have-descriptions
• node-shapes-must-have-descriptions
• preferred-media-type-representations
• standard-get-status-codes
• standard-post-status-codes
• standard-put-status-codes
• standard-delete-status-codes
• not-anonymous-types
• request-response-antipattern
• heterogeneous-union
• nil-union-antipattern
• unsupported-response-schema-shapes
• non-scalar-url-parameters
• open-schemas-ignored
• path-keys-no-trailing-slash