Getting started with API governance
Blog post from Redocly
The article provides guidance on setting up a basic OpenAPI governance system, focusing on simplifying the process of API linting to ensure a valid API description. It critiques the complexity of recommended rulesets and suggests starting with the fundamental 'struct' rule to check the correctness of an OpenAPI file using the Redocly CLI tool. The text emphasizes the importance of continuous linting integration into CI pipelines, using GitHub Actions as an example, to ensure consistent application of API standards. By automating the linting process, developers can avoid common errors and improve API governance incrementally. The article encourages building a custom ruleset by gradually adding rules that align with the organization's goals, while also utilizing tools like VSCode extensions and ignore files to address legacy issues and manage multiple API files.