liveBook · Manning

Big bang consistency approach

As explained in Automating API Delivery

A big bang consistency approach brings an existing API and its implementation into compliance with a ruleset through a single broad update.

A big bang consistency approach applies a complete API linting ruleset to an existing API, then updates its OpenAPI design and implementation until they comply. section 3.9

This approach creates several practical consequences:

  • Requires substantial changes to the OpenAPI file and project code. section 3.9
  • May require breaking changes before the API satisfies the complete ruleset. section 3.9
  • Can disrupt users of an API already operating in production. section 3.9

How Automating API Delivery covers it

How deep it goes
Describes the migration scope and risks, but stops short of prescribing commands or a detailed implementation plan.
Examples
Uses an existing production API whose OpenAPI design and implementation violate a latest API style guide.
What it assumes
Assumes an existing API, API implementation, OpenAPI design, and established linting ruleset or style guide.
What you can do after
Evaluate/understand the workload and consumer disruption involved in enforcing a complete ruleset on an existing API.
How it connects
Connects API linting with OpenAPI, API style guides, breaking changes, and gradual or multi-ruleset consistency approaches.
Cover of Automating API Delivery
liveBookmanning.com
Read Automating API Delivery on liveBook Get the book at manning.com

This explainer was generated by Manning's knowledge graph from the text of Automating API Delivery. The section links point to the parts of the book it draws on.