#REST API

求人を投稿 フォロー
0 フォロワー · 86 投稿

Representational state transfer (REST) は、Webサービスを作成するために使用される一連の制約を定義するソフトウェアアーキテクチャスタイルです。 RESTful Webサービス（RWS）と呼ばれる、RESTアーキテクチャスタイルに準拠したWebサービスは、インターネット上のコンピュータシステム間の相互運用性を提供します。 REST準拠のWebサービスを使用することで、要求されたシステムは、統一され事前定義されたステートレスな操作のセットを使用して、Webリソースのテキスト表現にアクセスし操作することができます。 SOAP Webサービスなどの他の種類のWebサービスは、独自の任意の操作セットを公開します。 詳細はこちら。

求人を投稿 フォロー
記事 Mihoko Iijima · 6月 1, 2021 6m read

REST/JSON の簡単なサンプルご紹介

これは InterSystems FAQ サイトの記事です。

InterSystems 製品を利用した REST/JSON の操作方法を、簡単なサンプルを利用して解説します。

サンプルでは、REST クライアント、HTML、ターミナルからデータ（JSON）を送信し、サーバ（InterSystems製品）で JSON 形式のデータを返す REST ディスパッチクラスを使った簡単な流れになっています。

サンプルは、https://github.com/Intersystems-jp/FAQ-REST-SimpleSample からダウンロードいただけます。

サンプルの利用手順

RESTディスパッチクラスとサンプルHTMLファイルが含まれています

(1) サンプルファイル（XML）のインポート

管理ポータルからインポートします（スタジオを利用されている場合は、スタジオでもインポートできます）。

管理ポータルは http://localhost:52773/csp/sys/UtilHome.csp でアクセスできます。

※ ポート番号はお使いの環境に合わせて変更してください。

管理ポータルにアクセスできたら以下メニューでインポートを行ってください。

#Caché #Ensemble #HealthShare #InterSystems IRIS #InterSystems IRIS for Health #HTML #JavaScript #REST API #ヒントとコツ #初心者
0
0 7822
記事 Mihoko Iijima · 12月 15, 2020 2m read

IIS で REST を動かす場合の設定

これはInterSystems FAQ サイトの記事です。

REST のベース URL を /rest とした場合の IIS と Webゲートウェイの設定内容は以下の通りです。

IIS の設定内容

アプリケーション /rest を作成し、ハンドラーマッピングで * = CSPms を定義します。

ハンドラーマッピングの設定手順は以下の通りです。

IIS > Default Website > アプリケーション /rest > "ハンドラーマッピング" をダブルクリック > モジュールマップの追加

  • 要求パス　:     *

  • モジュール:   CSPms

  • 名前　　　:   CSPGW    (任意の名前)

要求の制限 > [要求のマップ先が次の場合のみハンドラーを呼び出す] のチェックはオフにします。
※こちらの設定はデフォルトでは「チェックあり」になっていますのでご注意ください。

この構成により、IIS は /rest アプリケーションを Web ゲートウェイに転送します。

Webゲートウェイの構成

Web Gateway のアプリケーションアクセス から /rest を追加します。
→既存アプリケーションをクリックしてコピーし、アプリケーションパスを /rest に設定しIRISサーバを指定します。

#InterSystems IRIS #InterSystems IRIS for Health #REST API
0
0 3910
記事 Megumi Kakechi · 9月 16, 2020 4m read

HTMLからRESTを使って画像ファイルをアップロードする方法

これはInterSystems FAQ サイトの記事です。

HTMLからRESTを使って画像ファイルをアップロードする方法をご紹介します。

1.はじめに、以下のようなhtmlとクラスを作成してください。

＊UploadTest.html

<html lang="ja">
<head>
    <title>Upload</title>
</head>
<body>
    <input id="up" type="file" />
    <button id="btn">Upload</button>
    <div></div>
    <script type="text/javascript">
    const sendfile = function(e) {
        let up = document.getElementById("up");
        let file = up.files[0];
        let fd = new FormData();
        fd.append("imgfile", file);
        let xmlhttp = new XMLHttpRequest();
        xmlhttp.
#Caché #Ensemble #InterSystems IRIS #InterSystems IRIS for Health #CSP #REST API
3
1 3439
記事 Toshihiko Minamoto · 7月 20, 2021 7m read

Windows環境でnginxを構築する

皆さん、こんにちは。

InterSystems製品ではCache 2015.1からNGINXに対応しているのですが、インストールマニュアルを見るとC言語のソースファイルが提供されていて、「むむむ。。。コンパイルか。。。」と躊躇してしまいますね(^_^;)。
そこで、実際にWindows環境でNGINXをビルドしてみましたのでレポートします。

IRISのインストール

IRISまたはIRIS for Healthのキットを実行し、インストールします。
Nginxのアクセスに必要なUniversal Web gateway Moduleをインストールするには、セットアップタイプでCustomを選択し、
Web Server Gatewayを明示的にインストールする必要がありますので、ご注意ください。
    

また、今回はIRIS for Healthをインストールしていますので、C:\InterSystems\IRISHealthディレクトリにIRISをインストールしています。
IRISだったり、他のディレクトリにインストールされている場合は適宜インストールディレクトリを読み替えてください。

VisualStudioのインストール

Windows環境でコンパイルが必要ですのでVisualStudioをインストールします。

#InterSystems IRIS #InterSystems IRIS for Health #REST API #Web Gateway
0
0 2986
記事 Toshihiko Minamoto · 4月 20, 2021 7m read

動画再生時に早送り巻き戻しができない

開発者の皆さん
こんにちは。

先日、RESTのクラスを使って、PDFなどのファイルをアップロード、ダウンロードするサンプルをお送りしたお客さんからご質問を頂きました。
ダウンロード機能を使ってmp4などの動画を表示させた場合、以下のようにvideoの画面下のスライダーを移動しても、再生を進めたり戻したりができませんでした。

やはり、以下のようにスライダを動かすと、その時点の画像が表示されたほうが良いですね。

そこでgoogleで調べてみると、Http Range requestへの対応が必要ということですのでObjectScriptで作成してみました。

表示用html

ブラウザで動画を表示するための簡単なhtmlファイルは以下の通りです。sourceタグのURLにGETメソッドでアクセスし動画データを受信します。

<html>
<head>
<title>ストリーム再生 </title>
</head>
<body>
ストリーム再生<br>
    <video controls width="800" >
    <source src="http://localhost:52773/csp/storage/River.mp4" type="video/mp4"> 
    </video>
</body>
</html>

RESTクラス

RESTクラス(REST.

#Caché #InterSystems IRIS #REST API
0
0 2709
記事 Megumi Kakechi · 1月 6, 2021 1m read

Webサービスでエラー発生時にエラー詳細情報を取得する方法

これは InterSystems FAQ サイトの記事です

Web サービス(SOAP)またはREST で IIS を経由してクライアントにエラー応答する際、既定では IISが生成するデフォルトのエラーページ( HTTP 500 エラー)が返されます。

SoapFaultなど、サーバ側で出力したエラーの詳細情報は返されません。

IIS7 以降、WebクライアントがWeb サービスの障害の詳細情報を取得するための設定オプションが追加されました。

HTTP ステータスコードがエラーの場合に、既存の応答をどうするかを existingResponse 属性で指定することができます。

こちらの値を、既定の Auto から PassThrough に変更することで、エラーの詳細情報が返されるように変更できます。
※設定変更後、IISの再起動が必要です。

詳細や設定手順については、以下ドキュメントをご参照ください。
Microsoft IIS 7 以降の設定手順について【IRIS】

Microsoft IIS 7 以降の設定手順について

※web.config ファイルの手動編集よりも、IIS マネージャに組み込まれている構成エディタ を使用する方法がエラーが少なく安全です。

※HTTP エラー について
 

#Caché #Ensemble #InterSystems IRIS #InterSystems IRIS for Health #REST API #SOAP #ヒントとコツ
0
0 1925
記事 Toshihiko Minamoto · 8月 25, 2021 7m read

Webをデバッグする

この記事では、Caché Webアプリケーション（主にREST）のテストとデバッグを外部ツールを用いて行うことについて説明します。 パート2では、Cachéツールの使用について説明します。

サーバー側のコードを作成したのでクライアントからテストしたい、またはすでにWebアプリケーションが存在するが機能していない― そういったときに使用できるのがデバッグです。 この記事では、最も使いやすいツール（ブラウザ）から最も包括的なツール（パケットアナライザー）までを説明しますが、まずは、最も一般的なエラーとその解決方法について少し説明します。

#Caché #CSP #REST API #SOAP #デバッグ #フロントエンド
0
0 1801
記事 Toshihiko Minamoto · 5月 18, 2023 9m read

Python と IRIS で QR コードとバーコードを生成して読み取る

請求、支払いや領収、アイテムの配送や在庫を処理するアプリケーションでは、バーコードや QR コードの使用が必要となるのが一般的です。 単純なバーコードよりも多くの情報を格納できる QR コードは、さらに幅広いシナリオで使用されています。 したがって、バーコードと QR コードを生成する機能、またはそれらに格納されたデータを画像または PDF から読み取る機能が重要となります。 この記事では、Python と無料のライブラリを使用してこれを行う方法を説明します。

Pyzbar ライブラリ

pyzbar ライブラリは、zbar ライブラリを使って、Python 2 と 3 から 1 次元バーコードと QR コードを読み取ります。 以下の特徴が備わっています。

  • 純粋な Python。
  • PIL / Pillow 画像、OpenCV / ImageIO / NumPy ndarray、および raw バイトで動作。
  • バーコードの場所をデコード。
  • zbar ライブラリ以外の依存関係なし。
  • Python 2.7、Python 3.5～3.10 で検証済み。
#InterSystems IRIS #Embedded Python #REST API
Open Exchange
0
0 1796
記事 Mihoko Iijima · 10月 27, 2020 4m read

【はじめてのInterSystems IRIS】Interoperability（相互運用性）を使ってみよう！

皆さん、こんにちは！

InterSystems IRIS には [Interoperability（相互運用性）]というメニューがあります。

このメニューには、システム統合を簡単に作成できる仕組み（アダプタ、レコードマップ、BPM、データ変換など）が用意されていて、異なるシステムを簡単に接続することができます。

例えば、普段繋がっていないシステムを繋げるために相手の仕様に合わせてデータを受信（または送信）したり、データ送信前に別システムから情報を取得して追加したり、データベース（IRIS でもそれ以外でも）から情報を取得したり更新したり、データ中継の流れの中に様々な処理を含むことができます。

この記事のシリーズでは、Interoperability（相互運用性）でシステム統合を行う際、どのような仕組みで動作するのか、またどのような開発が必要になってくるのか、をご理解いただくためにサンプルコードをご覧いただきながら以下の項目を解説します。

まずはこのシリーズで使用するテーマをご紹介します。

ショッピングサイトを運営している会社があり、季節に合わせ商品情報の表示順を変更する作業を行っています。

#Ensemble #InterSystems IRIS #InterSystems IRIS for Health #REST API #初心者 #相互運用性
0
2 1500
記事 Akio Hashimoto · 10月 25, 2020 5m read

Dockerを利用した開発環境下でのIRISへのSSL接続方法

Docker環境下でWebアプリのコンテナとIRISのコンテナをRESTfulAPIで連携した時の SSL化方法。
ちなみにこの方法で管理ポータル等もSSL通信が可能になります。

参考サイト：

構成

※ Vue.jsはローカル上でホットリロードを利用した開発環境。 ※ IRISはローカル上に構築したDockerコンテナ下で稼働中。

今回、IRISをDockerコンテナで稼働させる方法は割愛します。

WebアプリケーションをHTTPSで利用する

Vue.jsで開発中のアプリケーションをhttpsでホットリロード利用出来るように起動する。

npm run serve -- --https

これで開発中のデバッグ画面をhttpsで呼び出して利用する事ができるようになるが、このままでは、httpsからhttpにアクセスする事が出来ない為、IRISのRESTを呼び出すことが出来ない。

#InterSystems IRIS #Docker #REST API #SSL #開発環境
2
0 1419
記事 Mihoko Iijima · 8月 5, 2020 8m read

【はじめてのInterSystems IRIS】セルフラーニングビデオ：アクセス編：IRIS での JSON の操作

IRIS サーバ側で JSON の操作を行う方法を解説します（3つのビデオに分かれています）。

ビデオ①　：ダイナミックエンティティの操作練習

ビデオ②　：ダイナミックエンティティで利用できるメソッドの練習

ビデオ③　：SQL関数と %JSON.Adapter の使い方

なお、このビデオには、以下の関連ビデオがあります。ぜひご参照ください。

ビデオ①

このビデオの目次は以下の通りです。

最初～　復習ビデオ／関連ビデオについて など

2:05～　JSONとは？

3:26～　JSONオブジェクト：ダイナミックエンティティの作成

//%DynamicObjectを使用した例
set json=##class(%DynamicObject).%New()
set json.Name="テスト太郎"
set json.Address="東京都新宿区"
write json.
#Caché #Ensemble #InterSystems IRIS #InterSystems IRIS for Health #JSON #ObjectScript #REST API #ビデオ #初心者
1
0 1399
記事 Toshihiko Minamoto · 11月 3, 2021 12m read

REST経由でファイル転送しプロパティに格納する - パート3

この連載の最初の記事では、大きなチャンクのデータをHTTP POSTメソッドのRaw本体から読み取って、それをクラスのストリームクラスとしてデータベースに格納する方法を説明しました。 2つ目の記事では、ファイルとファイル名をJSON形式にラップして送信する方法を説明しました。 

それでは、大きなファイルを分割してサーバーに送るという構想を詳しく見ていきましょう。 これを行うために使用できるアプローチにはいくつかあるのですが、 この記事では、Transfer-Encodingヘッダーを使用してチャンク転送を指示する方法を説明します。 Transfer-EncodingヘッダーはHTTP/1.1仕様で導入されたものです。RFC 7230第4.1項では説明されているものの、HTTP/2仕様からはその説明が無くなっています。 

#InterSystems IRIS #REST API
Open Exchange
0
0 1371
記事 Shintaro Kaminaka · 5月 1, 2020 14m read

仕様ファースト(APIファースト)アプローチによるREST APIの開発 

この記事では、REST API開発への仕様ファーストアプローチについて説明します。 

従来のコードファーストREST API開発は次のようになります。 

  • コードを書く 

  • RESTを有効にする  

  • ドキュメント化（REST APIとして） 

仕様ファーストのアプローチでは同じ手順を行いますが、順序が逆になります。 ドキュメントを兼ねた仕様書を作成し、そこからRESTアプリの定型文を生成して、最後にビジネスロジックを書きます。

これは、次の理由でメリットがあります。 

  • REST APIを使用したいと思っている外部開発者またはフロントエンド開発者向けの関連性のある有用なドキュメントが常に入手できます。 

  • OAS（Swagger）で作成された仕様をさまざまなツールにインポートして、編集、クライアント生成、API管理、ユニットテスト、その他の多くのタスクの自動化または簡略化を行うことができます。  

  • 改善されたAPIアーキテクチャ。コードファーストアプローチではAPIはメソッドごとに開発されるため、開発者はAPIアーキテクチャ全体を簡単に見落としてしまう可能性があります。これに対し、仕様ファーストの開発者は通常、APIの消費者の立場としてAPIと対話するように強制されます。これは、よりクリーンなAPIアーキテクチャの設計に役立ちます。 

  • 開発の迅速化。
#InterSystems IRIS #API #InterSystems API Manager (IAM) #REST API
0
0 1336
記事 Tomoko Furuzono · 6月 15, 2021 2m read

IISでRESTを動かす場合の設定方法

これは、InterSystems FAQサイトの記事です。
 

IISおよびWebゲートウェイの設定方法は以下のとおりです。

(1) IIS構成で以下の設定を行います
アプリケーション /rest を作成し、ハンドラーマッピングで * = CSPms のみ定義します。

IIS構成 > Default Website > アプリケーション /rest > "ハンドラーマッピング" をダブルクリック
  要求パス:     *
  モジュール:   CSPms
  名前:         CSPGW    (任意の名前)

要求の制限 > [要求のマップ先が次の場合のみハンドラーを呼び出す] のチェックはオフにします。
※こちらの設定はデフォルトでは「チェックあり」になっていますのでご注意ください。

この構成により、IIS は /rest アプリケーションをWebゲートウェイに転送します。


(2) Webゲートウェイの構成で以下の設定を行います
Web Gateway のアプリケーションアクセス から /rest を追加します。
→既存アプリケーションをクリックしてコピーし、アプリケーションパスを /rest に設定＆IRISサーバを指定します。

この構成により、Webゲートウェイは /rest アプリケーションをIRISサーバに転送します。

#InterSystems IRIS #REST API
0
0 1323
記事 Toshihiko Minamoto · 10月 28, 2021 8m read

REST経由でファイル転送しプロパティに格納する - パート1

InterSystems開発者コミュニティにおいて、CachéアプリケーションへのTWAINインターフェースの作成の可能性に関する質問が上がりました。 Webクライアントの撮像装置からサーバーにデータを取得し、そのデータをデータベースに保管する方法について、素晴らしい提案がいくつかなされました。 

しかし、こういった提案を実装するには、Webクライアントからデータベースサーバーにデータを転送し、受信データをクラスプロパティ（または質問のケースで言えばテーブルのセル）に格納できなければなりません。 この方法は、TWAINデバイスから受信した撮像データを転送するためだけでなく、ファイルアーカイブや画像共有などの整理といったほかのタスクにも役立つ可能性があります。 

そこで、この記事では主に、HTTP POSTコマンドの本体から、raw状態またはJSON構造にラップしてデータを取得するRESTfulサービスを記述する方法を説明することにします。

RESTの基本

具体的な話に入る前に、まずREST全般と、IRISでRESTfulサービスがどのように作成されるかについて簡単に説明しましょう。

Representational state transfer（REST）は、分散ハイパーメディアシステムのためのアーキテクチャスタイルです。

#InterSystems IRIS #REST API
Open Exchange
0
0 1312
記事 Megumi Kakechi · 3月 10, 2021 3m read

RESTでセッション共有化する方法

これは InterSystems FAQ サイトの記事です。

REST アプリケーションはステートレスであることが想定されています。

しかし、複数の REST 呼び出し間でデータを保持したい場合などの理由で、Webセッションを使用したい場合は、UseSession パラメータを使用することができます。

以下のように、Web アプリケーションのディスパッチクラスとして定義された %CSP.REST のサブクラスでUseSession パラメータを指定することで、CSPと同じようにWebセッションを使用することが可能となります。

Class REST.MyServices Extends %CSP.REST
{
 Parameter UseSession As Integer = 1;


詳細は以下のドキュメントをご覧ください。

REST での Web セッションの使用


以下は、UseSession パラメータを使用した簡単なサンプルになります。最初に、2つのクラスを作成してください。


*  REST.SessionTest.cls

Class REST.SessionTest Extends %CSP.
#Caché #Ensemble #InterSystems IRIS #InterSystems IRIS for Health #REST API #ヒントとコツ
0
0 1185
記事 Toshihiko Minamoto · 6月 8, 2021 17m read

サポートの現場から - Raw DEFLATEの圧縮/解凍機能の探求から、どのようにRESTによるNode.jsのコールアウトサーバー構築に至ったのか

以前、WRCケースのエスカレーションを受けました。お客様は、Cachéに、rawDEFLATE圧縮/解凍機能が組み込まれているかを尋ねていました。

DEFLATEについて話すには、Zlibについても話す必要があります。Zlibは、90年代半ばに開発された無料の圧縮/解凍ライブラリで、、デファクトスタンダードとなっているからです。

Zlibは特定のDEFLATE圧縮/解凍アルゴリズムと、ラッパー（gzip、zlibなど）内でのカプセル化するという考えの下で動作します。

Caché Object Script（COS）ではすでにGZIPがサポートされており、gzipファイルを使用するために、ファイルデバイスまたはtcpデバイス、またはStreamclassで/GZIP=1を使用できるようになっています。
http://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=GOBJ_propstream_gzip

「CSP-Gateway/Web-Gateway」Webサーバーモジュールでも、Caché-Serverから受信するhttp-data送信をGZIP圧縮/解凍するために、Zlibライブラリが使用されています。

#Caché #JavaScript #Node.js #ObjectScript #REST API #コールアウト #ベストプラクティス
0
0 1051
記事 Mihoko Iijima · 10月 27, 2020 10m read

【はじめてのInterSystems IRIS】Interoperability（相互運用性）：コンポーネントの作成（ビジネス・サービス）

この記事はこちらの投稿の続きの内容です。

前回の記事では、システム統合に必要なコンポーネントの中から、プロダクション内の処理の調整役となるビジネス・プロセスの作成について解説しました。

今回の記事では、プロダクションの情報入力窓口である、ビジネス・サービスの作成について解説します。

いよいよ「Interoperability（相互運用性）を使ってみよう！」の最後のコンポーネントです。

ビジネス・サービスは、IRIS 外部からの送信される情報の入力窓口で、外部 I/F に対してアダプタを使用する／しないを選択できます。

サンプルでは、3 種類のビジネス・サービスを用意しています（括弧内のリンクはサンプルコードへのリンク）。

  1. ファイルインバウンドアダプタを利用したファイル用ビジネス・サービス（Start.FileBS） 

  2. SOAP インバウンドアダプタを利用する Web サービス用ビジネス・サービス（Start.WS.WebServiceBS）

  3. アダプタを使用せず、ストアドプロシージャや REST で呼び出されるビジネス・サービス（Start.
#InterSystems IRIS #InterSystems IRIS for Health #REST API #ビジネスサービス #初心者 #相互運用性
0
0 954
記事 Mihoko Iijima · 3月 5, 2023 4m read

VSCode：RESTサービス実行中プロセスにアタッチしてデバッグする方法

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

1つ前の記事では、VSCodeのObjectScriptエクステンションに追加されたRESTサービスのデバッグツールについてご紹介しましたが、この記事では、RESTクライアントなどからHTTP要求を実行し、処理中のIRIS内プロセスにアタッチしながらデバッグを行う方法についてご紹介します。

#InterSystems IRIS #InterSystems IRIS for Health #REST API #デバッグ #ヒントとコツ #開発環境
5
0 905
記事 Mihoko Iijima · 3月 19, 2021 2m read

Webゲートウェイ／CSPゲートウェイ管理のデフォルトパラメータで設定できる各タイムアウト値について

これは InterSystems FAQ サイトの記事です。

各タイムアウト値の意味は以下の通りです。

(1) [サーバ応答タイムアウト]

この設定時間内に、IRIS/Caché での処理（ルーチンやクエリの実行）が終わらない場合は、ブラウザ側にエラーを返します。

例) この値が60秒の時に、ルーチン／メソッド／クエリ実行に 90秒 かかる場合にはエラーになります。

(2) [キューイングされたリクエストのタイムアウト]

CSP/REST で設定する IRIS/Caché サーバごとに、CSP/REST を同時実行できるプロセス数を制限できます。

たとえば、サーバ接続最大数＝３の場合、表示に数十秒かかるページを複数同時に要求した場合、4つ目以降のリクエストは、Web/CSP ゲートウェイ上で「キュー」に入り待ち状態になります。

このキューで待つ最大時間が (2) のタイムアウトになります。

(3) [非活動タイムアウト]

CSP/REST では、IRIS/Caché サーバ上に待ち受けプロセスが複数でき、「サーバ接続最大数」まで待ち受けプロセスが出来る可能性があります。

各プロセスが、次の要求が来るまで待機する時間がこのタイムアウト値になります。

タイムアウト後、プロセスは自動的に消滅します（これらのプロセスはライセンスを消費しません）。

詳細は下記ドキュメントページをご参照ください。

#Caché #Ensemble #HealthShare #InterSystems IRIS #InterSystems IRIS for Health #CSP #REST API #ヒントとコツ
0
0 903
記事 Mihoko Iijima · 7月 20, 2020 1m read

【はじめてのInterSystems IRIS】セルフラーニングビデオ：アクセス編：IRIS で作成する REST サーバの仕組み

IRIS で作成する REST サーバの仕組みを解説します。


このビデオには、以下の関連ビデオがあります。

もくじ

0:55～　今回の説明内容解説と関連ビデオについて

3:00～  RESTとは？

3:52～  動作の仕組み

6:23～　RESTディスパッチクラスとは

8:04～　RESTディスパッチクラスの実装方法

8:34～　RESTディスパッチクラス：全て手動で作成する方法　概要

9:30～　RESTディスパッチクラス：APIファーストで作成する方法　概要

11:12～　共通：ベースURLの設定（管理ポータルでの設定）

11:37～最後まで　確認できたこと

※YouTubeでご覧いただくと、もくじの秒数にジャンプできます。

#Caché #InterSystems IRIS #InterSystems IRIS for Health #REST API #ビデオ #初心者
0
0 818
記事 Hiroshi Sato · 9月 9, 2021 2m read

RESTでクロスドメイン制約を回避する方法

これは InterSystems FAQ サイトの記事です。
 

2025.1以降CORS関連の設定方法は大きく変わっています。

詳細は、以下の記事を参照してください。

jQueryを使用してIRISからJSONデータを取得する方法

%CSP.REST クラスを継承する REST 用ディスパッチクラスで REST を実装している場合は、クロスドメイン制約回避用に用意されたパラメータ HandleCorsRequest を利用します。

設定方法は以下の通りです。

REST 用ディスパッチクラスをスタジオで修正する場合は、
[クラス] > [リファクタ] > [オーバーライド] を開き、[パラメータ]タブを選択 > [HandleCorsRequest] を選択後OKボタンを押下します。
 

以下の定義が追加されるので、1を設定します。

Parameter HandleCorsRequest=1;

REST ディスパッチクラスを Atelier で修正する場合は、オーバーライドメニューの用意がないため、パラメータの定義を追加するか、%CSP.REST クラスを開き、HandleCorsRequest の定義をコピーし修正します。

#Caché #Ensemble #InterSystems IRIS #InterSystems IRIS for Health #REST API #セキュリティ
0
0 721
記事 Toshihiko Minamoto · 10月 22, 2020 7m read

JSONの機能強化

InterSystems IRIS 2019.1は公開されてからしばらく経ちますが、気づかれていない可能性のある、JSONの処理の強化機能について説明したいと思います。 最新のアプリケーションを構築する際、特にRESTエンドポイントを操作する際は、JSONをシリアル化形式として扱うことが重要です。

#InterSystems IRIS #JSON #REST API #XML #オブジェクトデータモデル
0
0 653
記事 Megumi Kakechi · 2月 18, 2021 3m read

jQueryを使用してIRISからJSONデータを取得する方法

jQuery（$.getJSON と $.ajax）を使用した InterSystems IRIS データのJSON形式での取得方法をご紹介します。

以下にサンプルをご用意しました。

https://github.com/Intersystems-jp/REST_JSON_sample


サンプルには、次の内容が含まれます。

・REST + JSON
・REST + CORS

※それぞれ、$.getJSON と $.ajax で取得する方法を記載しています。

※サーバ側ではSelect文の実行結果をJSON_OBJECT関数を使用しJSON文字列で出力しています。
　関数については以下のドキュメントをご覧ください。
　JSON_OBJECT関数


使用手順は以下になります。

1. USERネームスペースに json.xml をインポート・コンパイル
 

2. テスト用データの作成（ターミナルで以下のコマンドを実行する）

    USER>do ##class(Sample.Person).Populate(200)


3. 初期設定（REST用）

   管理ポータル > セキュリティ管理 > ウェブ・アプリケーション

   新しいウェブ・アプリケーションを作成ボタンを押す

   名前　/csp/user/rest
   ネームスペース    USER
   ディスパッチ・クラス　REST.Person

   保存ボタンを押す

4.

#InterSystems IRIS #InterSystems IRIS for Health #JSON #JavaScript #REST API
0
0 633
記事 Toshihiko Minamoto · 2月 7, 2024 2m read

Postman で Newman テストを作成する方法

コミュニティの皆さん、こんにちは！

私の IRIS Api Tester というアプリで使用する Postman コレクションのテストを作成する方法を説明します。

 

Newman とは？

Newman は、Postman コレクションを拡張可能な方法で自動的に実行できるコマンドラインツールです。 Newman でテストを作成することで、API エンドポイントの信頼性と正確性を確実にすることができます。 この記事では、Postman で Newman のテストを作成する方法と開始に役立つ実用的な例を紹介します。

 

Postman コレクションを作成したら:

テストスクリプトを書き始めることができます。

Postman のテストは、Postman スクリプトサンドボックスを使って JavaScript で記述します。 テストスクリプトを作成するには、リクエストを開いて「Test」タブに移動します。 ここで、API レスポンスを評価してその正確さを検証するカスタム JavaScript コードを作成できます。

例 1: レスポンスのステータスコードを確認する:

pm.test("Status code is 200", function () {
pm.response.to.have.status(200);
});

 

例 2: レスポンスの特定のフィールドの有無を検証する:

pm.
#InterSystems IRIS #InterSystems IRIS for Health #API #REST API #テスト
Open Exchange
0
0 610
記事 Mihoko Iijima · 7月 20, 2020 2m read

【はじめてのInterSystems IRIS】セルフラーニングビデオ：アクセス編：（REST）手動で作成するディスパッチクラス

IRIS で REST サーバを作成する際に準備する REST ディスパッチクラスを手動で作成する方法を解説します。

※関連ビデオで、OpenAPI 2.0 で定義したアプリケーションの仕様を利用する手順を使った API ファーストで作成するディスパッチクラスの解説ビデオもあります。

このビデオには、以下の関連ビデオがあります。

もくじ

最初～　復習ビデオ／関連ビデオについて など

2:20～ 　作成するディスパッチクラスの内容

4:20～　手動でRESTディスパッチクラスを作成する方法（手順説明）

5:07～　VSCode：クラス定義作成（手順説明）

　メモ：スタジオでの作成については、別のビデオでご説明しています。

#Caché #InterSystems IRIS #InterSystems IRIS for Health #REST API #ビデオ #初心者
1
0 609
記事 Toshihiko Minamoto · 7月 12, 2021 3m read

REST の高度な URL マッピング

現在では、基本的な REST API を Caché に実装する方法は一般的であり、これに関する優れたドキュメントが「REST in Caché」に掲載されています。

時々次のような疑問が投げ掛けられることがあります。

REST url のパラメータをオプションにするにはどうすればよいですか？

簡単に言えば、Caché では次のような URL をマッピングする URL マップを作成することができます。

http://server/API/object///old

この書き方は奇妙に見えるかもしれませんが、実際に有効な URL です。 詳細は、RFC3986 セクション 3.3 をご覧ください。

%CSP.Rest が提供しているフレームワークでは、実際に上記の URL に一致するマップを作成することができます。 上記の参照先のドキュメントには、URL マップは正規表現に変換されているという説明のみが補足として示されています。

この力を利用するには、正規表現を理解する必要があります。 Caché のコンテキストで正規表現の基礎を説明したドキュメントを Michael が執筆しています。こちらをご覧ください。 正規表現に慣れていない場合は、時間を取って一読することを強くお勧めします。

%CSP.Rest では、マップを実際に正規表現にコンパイルするのは UrlMap ブロックです。

#Caché #マッピング #REST API
0
0 541
記事 Megumi Kakechi · 9月 4, 2023 3m read

Webアプリケーションのトラブルシュート方法（ログの取得方法）

こちらの記事では、RESTやCSPなどの「Webアプリケーションのトラブルシューティング」のヒントをご紹介します。

何かしらのトラブルと思われる事象が発生した場合、確認したいのがログファイルになります。
各コンポーネント間のやり取りで、どこでどのようなトラブルが発生しているかを、それぞれログを取得して確認することができます。

① クライアント ⇔ Webサーバ間では、「Webサーバログ（IISやApacheのアクセスログなど）」、
② Webサーバ ⇔ Webゲートウェイ間では、「イベントログ」・「HTTPトレース」、
③ Webゲートウェイ ⇔ IRISサーバ間では、「ISCLOG」・「監査ログ」・「messages.log」などがあります。

こちらの記事では、IRISで取得できるログとして と で取得可能なログの取得方法をご紹介します。
 

② Web サーバと Webゲートウェイ間のアクセスに関連するログ情報


◆ イベントログ

1) Webゲートウェイ管理ページ（http://<IPアドレス>:<ポート>/csp/bin/Systems/Module.cxw）に接続します。

2) イベントログを削除します。
　[イベントログを参照] > ログをクリア をクリック

3) イベントログレベルを設定します。

#InterSystems IRIS #InterSystems IRIS for Health #CSP #REST API #ヒントとコツ
0
1 529
記事 Toshihiko Minamoto · 11月 1, 2021 9m read

REST経由でファイル転送しプロパティに格納する - パート2

この連載の第1回目の記事では、「大規模な」チャンクのデータをHTTP POSTメソッドのRaw本体から読み取って、それをクラスのストリームプロパティとしてデータベースに格納する方法について説明しました。 では、そのようなデータとメタデータをJSON形式で格納する方法について見てみましょう。

残念ながら、Advanced REST Clientでは、バイナリーデータをキーの値としてJSONオブジェクトを作成することはできません（もしかすると、私がまだ知らないだけかもしれません）。そこで、サーバーにデータを送信する単純なクライアントをObjectScriptで記述することにしました。

新しいRestTransfer.Clientというクラスを作成し、私のWebサーバーを指定するServer = "localhost"パラメーターとPort = 52773パラメーターをそれに追加しました。 そしてGetLinkクラスメソッドを作成しました。この中で、クラス%Net.HttpRequestの新しいインスタンスを作成し、プロパティを前述のパラメーターに設定します。 

実際にPOSTリクエストをサーバーに送信するために、クラスメソッドSendFileDirectを作成しました。

#InterSystems IRIS #REST API
Open Exchange
0
0 524