OpenAPI定義ファイルから特定リソースだけ抜き出す

OpenAPIで定義されたWebAPIがあり、それを利用したいがすべてのリソースは必要ない。全部の定義ファイルを型定義ファイル自動生成すると肥大化して困る…みたいなことがありました。利用しているリソースはほぼ一部だったので、それだけをOpenAPIの定義ファイルから抜き出せないか調べてみたら、ありました。

• openapi-extract

CLIとしても使えるので、GitHub ActionsなどのCIで自動化も簡単にできます。いくつかのオプションが有るのですが、複数指定ができる -o, --operationid オプションを使うと良いでしょう。

-o オプションの使い方はこちら。オプション指定のあと -- で区切る必要があります。

openapi-extract -o ID1 -o ID2 -- ./source.json ./target.json

これで必要なリソースだけのOpenAPI定義ファイルができました。便利。