OpenAPI Specification - CI/CD用語集の定義

OpenAPI Specification (旧Swagger) は、REST APIを機械可読かつ言語非依存でYAMLまたはJSONで記述したもので、あらゆるpath、メソッド、パラメータ、レスポンスのschemaを列挙します。

CIでは

pipelineはOpenAPIドキュメントをlintし、そこからclientコードを生成し、稼働中のサービスがspecと一致することを表明するcontract testを実行できます。これにより、release前に互換性を壊すAPI変更を検知できます。