BuildVu マイクロサービスにおける API の変更
2024.07 リリースにおいて、BuildVu マイクロサービスによって生成される zip ファイルに変更が加えられます。この変更はマイクロサービスのユーザーのみに影響します。BuildVu の JAR ファイルを直接使用している場合は、この変更の影響を受けません。
- zip ファイル名と親ディレクトリ名は、元のドキュメント名と一致していました
- zip ファイルの内部には、すべてのコンテンツを格納する親ディレクトリがトップレベルに配置されていました
MyDocument.zip
└─ MyDocument
├─ 1.html
├─ 2.html
└─ etc
- zip ファイル名は変換処理の uuid と一致します
- zip ファイルの内部では、変換されたドキュメントが親ディレクトリを使用せずトップレベルに直接格納されます
a96d569a-ec97-421e-997e-f1f23c169fa2.zip
├─ 1.html
├─ 2.html
└─ etc
マイクロサービスをより信頼性が高く予測可能なものにするため、マイクロサービスが内部的にファイルを保存する方法を変更しました。これにより、マイクロサービスは特定の問題のあるファイル名を拒否したり、長すぎるファイル名を切り詰めたりする必要がなくなりました。
この改善は、zip ファイルの命名規則を変更しなければ実現できませんでした。親ディレクトリ名の変更がワークフローに影響を与える可能性があるため、親ディレクトリを完全に削除することが良い機会だと考えています。これにより、親ディレクトリを必要としないワークフローが簡素化されます。この変更に対応することは、それほど複雑ではないと予想しています。
可能な限り、お客様のワークフローを壊す可能性のある API 変更を避けるよう常に努めています。今回のケースでは、変更を導入せずに改善を実現することは不可能であり、潜在的なデメリットよりもメリットの方が大きいと考えています。