Creating processes for API clarity and consistency
Plaid has implemented a comprehensive process for ensuring consistency in their APIs as they scale. The primary method is the API Review Council (APIRC), which consists of rotating members from various teams across the company. The council created an API Style Guide to codify style decisions and ensure new APIs are consistent with older ones. Additionally, a checklist for reviewers and submitters helps maintain consistency with the style guide. Changes to the Plaid API must be approved by the APIRC, which uses Jira for tracking and GitHub for setting up blocking reviewership in OpenAPI specifications. The council also sends out a monthly newsletter to increase awareness of resources for developers changing the API.
Company
Plaid
Date published
Feb. 17, 2022
Author(s)
Alexandra Hoffer
Word count
1206
Hacker News points
None found.
Language
English