Contract-Driven Development / OpenAPI で加速する契約駆動開発

はじめに

OpenAPIで仕様書を書いておくと、エコシステムによって色々開発を加速できるよということを記事にします。
具体的なコードなどは、imunew/openapi-ecosystemに置いときますので、参照ください。

定義ファイルの分割・ビルド

Swagger-CLIのbundleコマンドを使うと複数の定義ファイルから一つのOpenAPI仕様書を作成することができます。
具体的には、Swagger-CLIを利用します。
詳しいことは、以下の記事を参照ください。

• OpenAPI ファイルを 分割 / 結合 する 方法

Swagger-UIで仕様書をブラウザに表示する

Swagger-UIで仕様書をブラウザに表示することができます。
具体的には、Swagger-UIを利用します。
詳しいことは、以下の記事を参照ください。

• DockerでSwagger UIを起動してAPI仕様書をブラウザに表示する手順
• DockerでSwagger環境簡単構築！

APIクライアントの自動生成

OpenAPI仕様書にしたがって、APIクライアントを自動生成することができます。
具体的には、OpenAPI Generatorを利用します。
詳しいことは、以下の記事を参照ください。

• OpenAPI Generator + TypeScript で始める自動生成の型に守られた豊かなクライアント生活
• openapi-generator-cli による TypeScript 型定義

APIのモックサーバーを起動

OpenAPI仕様書にしたがって、APIクライアントを自動生成することができます。
具体的には、Prismを利用します。
詳しいことは、以下の記事を参照ください。

• OpenAPI×Stoplight Prismでモックサーバーをたてる
• OpenAPIからモックサーバを建てられるPrismを実際のプロジェクトに導入してみた

おわりに

業務委託で色々な現場を渡り歩いていますが、OpenAPIで仕様書を書いてあるプロジェクトは結構あるという実感があります。
が、今回紹介したようなツールを使っている現場は少ないように思います。
OpenAPIで仕様書を書いているだけでは、容易に実装と乖離してしまいますので、積極的に開発フローに組み込んでいくことが必要だと思います。
ぜひ、色々な現場で、契約駆動開発を加速していってください。
ではでは。