#openapi

OpenAPIは、APIの「設計図」みたいなもの Spring Bootでは `springdoc-openapi` を使うと、コードからOpenAPI定義を出せる ただし、手で保存する方法は面倒で、CIには向かない 記事の核心は「アプリを起動した状態で、MavenプラグインにOpenAPIを取りに行かせる」こと そのために `openapi` 用のSpring profile を分けているのがうまい CIでAPI仕様を自動生成できると、フロントエンド連携や契約テストがかなり楽になる この記事は、Spring Bootアプリから OpenAPI 仕様を自動生成し、それを CI pipeline に自然に組み込む方法を紹介しています。 まず前提として、OpenAPIはAPIの仕様を機械が読める形で表したものです。人間にとっては「このAPIはGETで、こういう入力を受けて、こういう出力を返す」と読めるし、ツールにとっては「クライアントコードを作るための材料」になります。 ここが大事で、OpenAPIはただのドキュメントではありません。 実際には次のような用途でかなり役に立ちます。