重要である理由

IAMの管理を手動で行うには手間ががかります。OpenAPI（Swagger）仕様を使用して、APIがすでにしっかりとドキュメント化されている場合はなおさらです。 Open API仕様から直接、Kongサービスやルートを自動生成できたらいいのにと思いませんか？

このObjectScriptメソッドはまさにその処理を行います。仕様クラスの XData ブロック内に保管されているOpenAPI 2.0仕様を読み取り、IAM構成を同期するために使用できるdecKと互換性があるYAMLファイルを生成します。

このアプローチは：

• 手動による構成エラーを削減します
• ゲートウェイをAPI仕様に常に同期します
• デプロイメントとオンボーディングを高速化します

前提条件：

• InterSystems IRIS、またはIRISベースのプラットフォーム
• InterSystems API Manager
• Deck CLIツール

メソッドの内容

メソッド ConvertOpenAPIXDataToDeckYAML の機能は次のとおりです。

1. OpenAPI仕様を読み取る： 指定したクラス内の OpenAPI という名前の XData ブロックから読み取ります。

2. JSONを解析する：動的オブジェクトに変換します。

3. エンドポイントを抽出する ：HTTPメソッドも抽出します。

REST API（Representational State Transferアプリケーションプログラミングインターフェース）は、GET、POST、PUT、DELETEなどのHTTPメソッドを使用してウェブアプリケーション間で通信するための標準化された方法です。 リソースを中心に設計されており、リソースにはユーザーやファイルなどあらゆるものが含まれます。 各リソースは一意のURLで識別され、これらのリソースのやり取りはステートレスです。クライアントからサーバーへの各リクエストには、リクエストを理解して処理するために必要なすべての情報が含まれている必要があります。 このステートレス性と標準的なHTTPメソッドの使用により、REST APIは高度にスケーラブルで理解しやすく、さまざまなシステムとの統合も簡単です。 RESTの原則に従うことで、開発者は一貫性があり、使いやすく、幅広いタスクに対応できるAPIを作成できます。

InterSystemsは、さまざまなツールと技術でREST API開発をサポートします。 この記事シリーズでは、私自身が特にお勧めするものを取り上げます。 記事は以下のように分類されています。

• OpenAPI 2.0仕様の記述方法
• OpenAPI 2.0仕様を使用したREST APIのドキュメント化および開発。