SwaggerUI v4 および SwaggerEditor v4 の今後の展開

  2021年7月27日

Swagger OSS チームが取り組んできたこと、および私たちが期待している最新の機能強化について、簡単な最新情報をお伝えしたいと思います。

  • SwaggerUISwaggerEditor の v4 リリースブランチの作業を開始しました。
  • SwaggerUI@v4 のベータ版はすでにリリースされており、SwaggerEditor@v4 はまもなくリリースされます。

SwaggerUI v4 と SwaggerEditor v4 の新機能

v4 への移行により、React の最新機能(Hooks、Contexts など)を使用し、OpenAPI 3.1 の採用に備えるために、SwaggerUI/SwaggerEditor をさらに進化させることができます。

SwaggerUI v3 と SwaggerEditor v3 はどちらも現在、React@15 の古いブランチで実行されており、最後に更新されたのは 9 か月前です。Redux も同様で、古いバージョンに縛られています。v4 のリリースにより、これらのライブラリを可能な限り最新のバージョンにすることができます。

  • react 15.7.0 -> 17.0.2
  • react-dom 15.7.0 -> 17.0.2
  • redux 3.7.2 -> 4.1.0
  • react-redux 4.4.10 -> 7.2.4

このリリースは、React と Redux の古いバージョンに対するサポートを終了するため、破壊的な変更と見なしています。この変更の影響は、既存のコードをレンダリングするために SwaggerUI/SwaggerEditor をライブラリとして使用している組織で最も大きく感じられるでしょう。場合によっては、この方法で SwaggerUI/SwaggerEditor と統合する他のライブラリを使用している可能性もあります。

どちらの場合も、既存のコードは SwaggerUI/SwaggerEditor と同じバージョンの React で実行する必要があります。v4 を使用するということは、既存のコードで使用されているすべての React コードを更新して React@17 で実行できるようにするか、異なるバージョンの React を使用して v4 を実行するかのいずれかを意味します。これは段階的なアップグレードと呼ばれ、こちらに文書化されています。

Swagger v4 を今すぐ試す方法

v4 リリースブランチを維持し、ローカルでテスト目的で独自のアーティファクトをチェックアウトしてビルドできます。

SwaggerUI@v4 の NPM パッケージはすでに利用可能で、SwaggerEditor@v4 の NPM パッケージは 2021 年 7 月 26 日の週に利用可能になる予定です。

推定リリーススケジュール

v4 ベータ版は 2021 年 7 月 7 日までに利用可能になると予想しています。最初の v4 RC(リリース候補)が利用可能になるまでには、さらに数週間かかる場合があります。最初の v4 ベータ版と最初の RC の間の期間には、新しい機能を実装した PR はマージされません。マージされた PR はバグ修正に限定し、これらのバグ修正は v4 リリースブランチにバックポートされます。

v4 の作業、ライブラリの更新、および検出された異常に関する詳細情報は、次のイシューで確認できます。

3.x ブランチの寿命

安定版の v4.0.0 リリース後、最低 4〜6 週間のメンテナンス期間は 3.x ブランチのサポートを継続します。3.x のメンテナンス期間中は、セキュリティ修正やバグ修正を 3.x ブランチに自動的にバックポートし、v3 のパッチリリースを発行します。