REST API のリストおよびドキュメント化

REST サービスの検出

/api/mgmnt サービスを使用して、インスタンス上で使用可能な REST サービスを検出するには、以下の REST 呼び出しを使用します。

• HTTP アクションとして、GET を選択または指定します。

• URL として、以下の形式の URL を指定します。

  http://localhost:52773/api/mgmnt/v2/

  または、1 つのネームスペースだけを調べる場合は、以下の形式の URL を指定します。

  http://localhost:52773/api/mgmnt/v2/:namespace

  localhost はサーバの名前、52773 は InterSystems IRIS が実行されている Web サーバ・ポート、namespace は、調べるネームスペースです。

(これらの呼び出しでは、手動コーディングの REST サービスは無視されます。手動コーディングの REST アプリケーションを検出するには、呼び出し GET /api/mgmnt/ および GET /api/mgmnt/:v1/:namespace/restapps を使用します。)

呼び出しが成功すると、InterSystems IRIS は、REST サービスをリストする JSON 形式の配列を返します。以下に例を示します。

[
  {
    "name": "%Api.Mgmnt.v2",
    "webApplications": "/api/mgmnt",
    "dispatchClass": "%Api.Mgmnt.v2.disp",
    "namespace": "%SYS",
    "swaggerSpec": "/api/mgmnt/v2/%25SYS/%Api.Mgmnt.v2"
  },
  {
    "name": "myapp",
    "webApplications": "/api/myapp",
    "dispatchClass": "myapp.disp",
    "namespace": "USER",
    "swaggerSpec": "/api/mgmnt/v2/USER/myapp"
  }
]

REST 対応 Web アプリケーションの検出

/api/mgmnt サービスを使用して、インスタンス上で使用可能な REST 対応 Web アプリケーションを検出するには、以下の REST 呼び出しを使用します。

• HTTP アクションとして、GET を選択または指定します。

• URL として、以下の形式の URL を指定します。

  http://localhost:52773/api/mgmnt

  または、1 つのネームスペースだけを調べる場合は、以下の形式の URL を指定します。

  http://localhost:52773/api/mgmnt/v1/:namespace/restapps

  localhost はサーバの名前、52773 は InterSystems IRIS が実行されている Web サーバ・ポート、namespace は、調べるネームスペースです。

"GET /api/mgmnt/" および "GET /api/mgmnt/:v1/:namespace/restapps" のリファレンス・セクションを参照してください。

REST サービス・クラスの検出

%REST.APIOpens in a new tab クラスを使用して、インスタンス上で使用可能な REST サービスを検出するには、そのクラスの以下のメソッドを使用します。

GetAllRESTApps()

GetAllRESTApps(Output appList As %ListOfObjects) as %Status

このサーバ上の REST サービスのリストを出力として返します。出力引数 applist は、%ListOfObjectsOpens in a new tab のインスタンスです。リスト内の各項目は、REST サービスに関する情報を含む %REST.ApplicationOpens in a new tab のインスタンスです。これには、関連する Web アプリケーションがない REST サービスも含まれます。このメソッドでは、手動コーディングの REST サービスは無視されます。

GetRESTApps()

GetRESTApps(namespace as %String,
            Output appList As %ListOfObjects) as %Status

namepace で指定されたネームスペース内の REST サービスのリストを出力として返します。"GetAllWebRESTApps()" を参照してください。"GetAllRESTApps()" を参照してください。

REST 対応 Web アプリケーションの検出

%REST.APIOpens in a new tab クラスを使用して、インスタンス上で使用可能な REST 対応 Web アプリケーションを検出するには、そのクラスの以下のメソッドを使用します。

GetAllWebRESTApps()

GetAllWebRESTApps(Output appList As %ListOfObjects) as %Status

このサーバ上の REST 対応 Web アプリケーションのリストを出力として返します。出力引数 applist は、%ListOfObjectsOpens in a new tab のインスタンスです。リスト内の各項目は、Web アプリケーションに関する情報を含む %REST.ApplicationOpens in a new tab のインスタンスです。

GetWebRESTApps()

GetWebRESTApps(namespace as %String,
               Output appList As %ListOfObjects) as %Status

namepace で指定されたネームスペース内の REST 対応 Web アプリケーションのリストを出力として返します。"GetAllWebRESTApps()" を参照してください。