RAML 0.8 または 1.0 に完全準拠するためのパブリッシュ済み RAML API 仕様の変更

2019 年 1 月 10 日の時点で、コードエディタ (Design Center の API Designer に用意されている 2 つのエディタのうちの 1 つ) は、それ以前に作成されている RAML API 仕様プロジェクトに対してより厳しい検証をデフォルトで行います。そのため、この日付前に作成されたプロジェクトの API 仕様には、旧バージョンのコードエディタではエラーとして認識されなかった無効な RAML が含まれている可能性があります。

パブリッシュ済みの API を Design Center のコードエディタで開いて、エディタの右上隅にある機能を使用して厳格な検証を実行してください。(このトグルスイッチは、2019 年 1 月 10 日以前に作成されたプロジェクトでのみ表示されます。)このガイドを使用して、以前のコードエディタでは見過ごされ、今ではメッセージが生成される原因となる、よくある RAML の問題を解決してください。このガイドが取り上げていない問題については、 raml.org で RAML 0.8 と 1.0 の仕様を参照してください。

コードエディタは、RAML の問題をより正確にチェックするだけではなく、正規表現の検証も行うようになりました。パブリッシュ済みの API 仕様に無効な正規表現が含まれている場合、その API 仕様をエディタで開くとエラーとなります。

2020 年 1 月 10 日までという長い猶予期間が設けられていますので、パブリッシュ済みの API 仕様に含まれている可能性のある無効な RAML と正規表現を修正してください。猶予期間の満了後は、問題が含まれたままの API 仕様の再パブリッシュや再デプロイはできなくなります。

フォームに情報を入力することで API 仕様を作成できる API Designer のツールであるビジュアルエディタで作成した API 仕様については、チェックする必要はありません。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub