VSCode：RESTサービスのデバッグ

記事

Mihoko Iijima · 2023年3月3日 3m read

開発者の皆さん、こんにちは！

IRISのRESTディスパッチクラスのデバッグがVSCodeで簡単にできるようになりましたので、利用手順についてご紹介します。

ObjectScriptエクステンションバージョン2.4.0 に追加されています。
のアイコンクリック時に表示されるエクステンション一覧でObjectScriptエクステンションに「Update」と表示されている場合は、更新を行ってください。

事前準備

まずは、RESTディスパッチクラスが保存されているIRISのネームスペースにVSCodeから接続する必要があります。

接続方法は以下２種類あります。

ワークスペース単位にIRISのサーバ情報（ホスト名、ポート番号、接続ユーザ名）と、IRISへの接続情報（サーバ情報で作成したサーバ名、ネームスペース）を指定します。

その2：ユーザ単位に設定するsettings.jsonにIRISのサーバ情報を設定し、ワークスペース単位に設定するsettings.jsonに使用するサーバ情報のみを指定する。

VSCodeを使用するユーザ単位でIRISのサーバ情報（ホスト名、ポート番号、接続ユーザ名）を固定情報として設定します。ワークスペースに設定するsettings.jsonには、IRISへの接続情報（サーバ情報で作成したサーバ名、ネームスペース）のみを設定します。

ObjectScriptエクステンションで提供される「Debug REST Service」メニューでデバッグが実行できます。

図解のクラスでお試しいただく場合は、こちら👉https://github.com/Intersystems-jp/RESTDebug-VSCode をご利用ください。

※ObjectScriptエクステンションの最新をご利用ください。

手順は以下の通りです。

1) デバッグ対象メソッドにブレークマークを設定します。

上の図例では、ワークスペース上のソースコードに対してブレークマークを設定していますが、をクリックしサーバ側コードに対してブレークマークを設定しデバッグを開始することもできます。

2) ソースコード上で右クリック→「Debug REST Service」を選択します。

3) HTTPメソッドとURLを指定します。

4) クエリパラメータがあれば「QUERY PARAMETERS」タブで指定します。

3) の画面のURLに ? を使用してクエリパラメータを追加できません。「QUERY PARAMETERS」をご利用ください。

5) Bodyの指定が必要であれば「BODY」タブで指定します。

6) Start Debuggingボタンをクリックしてデバッグを開始します。

開始後は、以下のボタンを利用してデバッグを進めます。デバッグ終了時は「Stop」を押して終了してください。

ぜひ皆さんのお手元でも試してみください！

次の記事では、VSCodeの「Debug REST Service」を使わずに、外部クライアント（RESTクライアントなど）からHTTP要求を実行し、処理中のIRIS内プロセスにアタッチしながらデバッグを行う方法をご紹介します。