Define & Validate APIsValidation RulesetsAPIMatic Rulesets
APIMatic Rulesets Overview
The rulesets APIMatic uses to validate and lint APIMatic documents.
APIMatic validates every API definition against the rulesets below, whatever its format. They include checks a format's standard may not enforce itself but that APIMatic needs to produce good SDKs, portals, and transformations.
Validation rulesets
These rulesets make sure your API definition conforms to its format and is technically correct.
| Ruleset | Code prefix | Rules |
|---|---|---|
| Input File Validation | INPUTFILE_V | 10 |
| Metadata File Validation | METADATA_V | 7 |
| APIMatic Preliminary Validation | APIMATICPRE_V | 102 |
| APIMatic Syntax Validation | APIMATICSYNTAX_V | 1 |
| APIMatic Process Validation | APIMATICPROCESS_V | 3 |
| APIMatic Validation for Code Generation | APIMATICCODEGEN_V | 87 |
| APIMatic Post-Processing Validation | APIMATICPOSTPROCESS_V | 47 |
| APIMatic Post-Processing Validation For Code Generation | APIMATICPOSTPROCESSCODEGEN_V | 9 |
Linting rulesets
These rulesets are style checks and recommendations. They improve the definition without affecting whether it's valid.
| Ruleset | Code prefix | Rules |
|---|---|---|
| APIMatic Preliminary Linting | APIMATICPRE_L | 24 |
| APIMatic Linting for Portal Generation | APIMATICDOCS_L | 13 |