Compliance check

As explained in Automating API Delivery

An API compliance check is an automated or manual verification that an API definition conforms to applicable governance standards.

A compliance check verifies whether an API definition follows applicable API standards and governance rules. Automating these checks reduces review delays while preserving consistent API quality. section 1.7

Store API definitions and configuration in Git, then run automated API standards checks or linting in the delivery pipeline. Fast feedback helps teams correct design issues early instead of waiting for repeated centralized reviews. section 1.7

Use compliance checks to divide governance work appropriately:

• Automate repeatable standards checks for faster feedback and reduced frustration. section 1.7
• Retain human review for concerns automation cannot assess, such as shared resource-model naming and attribute design. section 1.7

Figure 1.9 In APIOps, you automate API governance as much as possible to deliver better compliance and reduced lead times.

Automation balances compliance with shorter API delivery lead times. section 1.7

How Automating API Delivery covers it

How deep it goes

Explains automation, Git-based workflow, and human-review boundaries, but stops short of naming specific rules or linting tools.

Examples

Uses style guides, API definition files, Git configuration, delivery pipelines, linting, and resource-model reviews.

What you can do after

Apply it via Git-based API workflows and automated linting while reserving human review for non-automatable design judgments.

How it connects

Connects API governance, API standards, API linting, API design, and API resource models.

liveBookmanning.com

Read Automating API Delivery on liveBook Get the book at manning.com

Related concepts

• APIOpsused by · APIOps is the practice of automating the governance, delivery, and operation of API products across their life cycle.
• testuses · A test is a procedure or check that evaluates behavior using specified inputs or evidence against expected results or criteria.
• documentation reviewuses · Documentation review is a systematic examination of documentation or records to assess relevant properties such as accuracy, completeness, clarity, or compliance.

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.