OpenAPI - CI/CD用語集の定義

OpenAPI は HTTP API を機械可読なドキュメントで記述するための業界標準の仕様フォーマットです。

OpenAPI は HTTP API を記述するための標準的で言語非依存の仕様フォーマットで、以前は Swagger と呼ばれていました。CI の job は一般に OpenAPI ドキュメントを lint し、それに対してレスポンスを検証します。

OpenAPI ドキュメントはコード生成、mock server、検証を駆動します。CIでは、それらを lint し、バージョン間の diff を取って breaking change を検出し、実行中のサービスが仕様に一致するかを検証できます。

CIでは

Spectral のようなツールが OpenAPI ファイルを lint し、schema diff ツールが base ブランチと pull request の間の breaking change を検出します。