新しい Swagger Editor と Swagger UI

前回のアップデートから2年、そして何万ものユーザーフィードバックに耳を傾けた結果、新しい Swagger UI と Swagger Editor がついに登場しました！  これらは、API 設計とドキュメント作成プロセスにスピードと信頼性をもたらします。新しいバージョンでは、ユーザーがインターフェースを完全にカスタマイズし、コアの Swagger プラットフォーム上に独自の機能を構築できる拡張メカニズムも導入されています。 

各 GitHub リポジトリでプロジェクトを見つけることができます。

Swagger-UI: https://github.com/swagger-api/swagger-ui

Swagger-Editor: https://github.com/swagger-api/swagger-editor

当然、質問が予想されるため、以下に FAQ セクションを追加しました。

FAQ

え、何が起こったの？

Swagger-UI は2011年に、Swagger-Editor は2014年に初めてリリースされました。ご存知のように、これら2つのプロジェクトは独立して開発され、異なる技術に基づいており、同じユーザーエクスペリエンスを提供していませんでした。私たちは、両方に同様の技術基盤を使用して、2つのプロジェクトを「マージ」しました。作業の一環として、swagger-js も完全に作り直しました。

じゃあ、プロジェクトは1つになったの？

いいえ、そうではありません。新しいプラグインシステムを作成しました。Swagger-UI は現在、そのシステムのコアを含んでおり、エディターは単にそれにプラグインのセットが追加されたものです。これらのプラグインがどのように機能するかを理解しなくても、Swagger Editor をプロジェクトとして実行する方法はまだ提供しています。

なぜそんなに苦労してまで？

いくつか理由があります。

  • 上記で述べたように、技術のマージと新しい技術への移行です。プロジェクトは古くなり、最新の状態にする時期が来ていました。
  • 両方のプロジェクトに慣れた UI を提供したかったのです。
  • カスタマイズ性を高めるためです。大幅に。
  • 拡張性を高めるためです。ご想像の通り、大幅に。
  • 次のバージョンの仕様をサポートしやすくするためです。
  • レンダリングと検証のパフォーマンスを向上させるためです。
  • エディターでの検証を改善し、ユーザーがゼロから仕様を書きやすくするためです。

ねえ、UI どうなったの？！ Swagger-X の方がずっと好きだったんだけど！

既存のプロジェクトの最高の部分を取り入れ、新鮮にしました！今後数週間でさらに変更を加える可能性が高く、次のバージョンの仕様をサポートする際には間違いなくさらに変更を加えるでしょう。

でも、古い見た目が欲しい！

それが新しいプロジェクトの素晴らしい点です。必要に応じて UI を変更するのがずっと簡単になりました。

次のバージョンの仕様をサポートしていますか？

上記で述べたように、この変更の主な理由の1つは、次のバージョンの仕様をサポートしやすくすることです。それが私たちの今後の主要なタスクです。

以前のバージョンのプロジェクトの問題はどうなりますか？さらに開発されますか？いつまでサポートを期待できますか？

次のバージョンの仕様と、新しいプロジェクトに投入した作業を考慮すると、以前のバージョンを積極的に開発することはもうありません。私たちの努力は新しいバージョンのプロジェクトに集中しています。移行のために十分な時間を確保するため、古いバージョンについては数ヶ月間サポートを継続します。公式サポート終了に関する正式な発表を行います。問題がどれほど重大であるかに応じて、古いプロジェクトの新しいリリースを一部のケースで提供する場合があります。

新しいプロジェクトでサポートされている仕様バージョンは何ですか？

2.0 で、次のバージョンの仕様のサポートに取り組んでいます。古いバージョンはサポートされなくなりました。バージョン2.0より古い仕様を使用している方には、時間を取ってアップグレードを検討することをお勧めします。

機能Xが不足している！機能Yが壊れている！

おっと。機能の同等性を可能な限り近づけようとしましたが、いくつか見落としている可能性があります。不足している機能をプロジェクトのチケットとして提出して、私たちを助けてください。

どうすれば手助けできますか？

以前と同じように

  • 何かうまくいかない？チケットを提出してください！
  • 何か不足している？チケットを提出してください！
  • もっと見たい？チケットを提出してください！
  • 上記のいずれかを解決する時間がありますか？プルリクエストを送信してください！

それだけ簡単です。