I am continuing to document the API governance rule landscape, beginning with Spectral, but then adding on Vacuum. Next I wanted to inventory what APIMATIC makes available–they have the most complete set of rules. SDK generation requires the most complete OpenAPI, so it makes sense that APIMATIC has invested in this level of detail. APIMATIC has their rules conveniently organized into the following groups.
- OpenAPI Root Information (OPENAPI3APIMATIC_L001 - OPENAPI3APIMATIC_L039)
- OpenAPI Info (OPENAPI3APIMATIC_L040 - OPENAPI3APIMATIC_L059)
- OpenAPI Contact (OPENAPI3APIMATIC_L060 - OPENAPI3APIMATIC_L079)
- OpenAPI Licenses (OPENAPI3APIMATIC_L080 - OPENAPI3APIMATIC_L099)
- OpenAPI Servers (OPENAPI3APIMATIC_L100 - OPENAPI3APIMATIC_L149)
- OpenAPI Components (OPENAPI3APIMATIC_L150 - OPENAPI3APIMATIC_L179)
- OpenAPI Paths (OPENAPI3APIMATIC_L180 - OPENAPI3APIMATIC_L199)
- OpenAPI Path Items (OPENAPI3APIMATIC_L200 - OPENAPI3APIMATIC_L229)
- OpenAPI Operations (OPENAPI3APIMATIC_L230 - OPENAPI3APIMATIC_L299)
- OpenAPI External Documentation (OPENAPI3APIMATIC_L300 - OPENAPI3APIMATIC_L329)
- OpenAPI Parameters (OPENAPI3APIMATIC_L330 - OPENAPI3APIMATIC_L369)
- OpenAPI Request Body (OPENAPI3APIMATIC_L370 - OPENAPI3APIMATIC_L399)
- OpenAPI Media Types (OPENAPI3APIMATIC_L400 - OPENAPI3APIMATIC_L429)
- OpenAPI Encoding (OPENAPI3APIMATIC_L430 - OPENAPI3APIMATIC_L459)
- OpenAPI Responses (OPENAPI3APIMATIC_L460 - OPENAPI3APIMATIC_L499)
- OpenAPI Callbacks (OPENAPI3APIMATIC_L500 - OPENAPI3APIMATIC_L529)
- OpenAPI Links (OPENAPI3APIMATIC_L530 - OPENAPI3APIMATIC_L569)
- OpenAPI Headers (OPENAPI3APIMATIC_L570 - OPENAPI3APIMATIC_L599)
- OpenAPI Tags (OPENAPI3APIMATIC_L600 - OPENAPI3APIMATIC_L629)
- OpenAPI References (OPENAPI3APIMATIC_L630 - OPENAPI3APIMATIC_L659)
- OpenAPI Schemas (OPENAPI3APIMATIC_L660 - OPENAPI3APIMATIC_L799)
- OpenAPI Discriminators (OPENAPI3APIMATIC_L800 - OPENAPI3APIMATIC_L839)
- OpenAPI XML (OPENAPI3APIMATIC_L840 - OPENAPI3APIMATIC_L869)
- OpenAPI Security Schemes (OPENAPI3APIMATIC_L870 - OPENAPI3APIMATIC_L909)
- OpenAPI OAuth 2.0 Flows (OPENAPI3APIMATIC_L910 - OPENAPI3APIMATIC_L929)
- OpenAPI Security Requirements (OPENAPI3APIMATIC_L930 - OPENAPI3APIMATIC_L949)
- OpenAPI Vendor Extensions (OPENAPI3APIMATIC_L950 - OPENAPI3APIMATIC_L969)
- Miscellaneous (OPENAPI3APIMATIC_L970 - OPENAPI3APIMATIC_L999)
As I said, APIMATIC will be the high water mark for the rules work I am doing. I will be working to connect the dots between Spectral, Vacuum, and APIMATIC. While this is possible for many rules, there are many that are apples to oranges comparisons. Luckly APIMATIC has taken a very modular approach similar to what I am taking so it makes for a nice benchmark to standardize again. Next up is Redocly who has their own approach to API governance, while also supporting Spectral as a default, similar to what Vacuum is doing.
Full Disclosure: APIMATIC is an API Evangelist sponsor, but this post is part of regularly scheduled work.
