ODataとは?
OData(Open Data Protocol)は、RESTful APIの構築と消費に関する一連のベストプラクティスを定義するISO/IEC認定のOASIS標準です。 ODataは、リクエストとレスポンスのヘッダー、ステータスコード、HTTPメソッド、URL変換、メディアタイプ、ペイロード形式、クエリオプションなどを定義するための多様なアプローチを気にせずに、RESTful APIを構築しながらビジネスロジックに専念するのに役立ちます。 また、ODataには変更の追跡、再利用可能なプロシージャの関数/アクションの定義、および非同期/バッチリクエストの送信に関するガイダンスも提供されています(出典: OData.org)。
ODataのユースケース
ODataとInterSystems IRIS
InterSystems IRISはODataをサポートしていませんが、OData Server for InterSystems IRISを使用して、永続クラスをRESTとして公開することが可能です。
次の手順に従ってください。
- 任意の永続クラスでInterSystems IRISインスタンスを起動します。
- ブラウザで次にアクセスします: http://localhost:8080/ 画面でパラメーターを設定します:
- これは私のインスタンスのパラメーターです。 ご利用のIRISインスタンスにパラメーターを設定してください。 ネームスペースにあなたのIRISのネームスペース、スキーマにSQLテーブルスキーマ、ポートにJDBCデータベース接続へのポートを設定します。
- [送信]を押すと、OData Server Dockerインスタンスが再読み込みされてパラメーターが適用されます。
- http://localhost:8080/odata.svc/にアクセスし、IRISスキーマのすべての永続クラスを表示します。 私の場合は次のようになります。
- 永続クラスに移動するには、次を参照します: http://localhost:8080/odata.svc/<Persistent_Class> 例: http://localhost:8080/odata.svc/Animal
- ODataサーバーは次のようにAnimalデータをリスト表示します。
- JSON形式で表示するには、次を参照します: http://localhost:8080/odata.svc/Animal?$format=application/json 次に例を示します。
- 行の詳細を表示するには、次を参照します: http://localhost:8080/odata.svc/Animal(8)?$format=application/json
- 削除するには、Postmanで次を指定してDELETEを送信します: http://localhost:8080/odata.svc/Animal(8)
- 挿入するには、次のようにPostmanで http://localhost:8080/odata.svc/Animalとプロパティ名と値のペアを持つJSON本体を指定してPOSTを送信します。
- 永続クラスを使用して、すべてのCRUD操作を実行できます。
- IRIS OData Serverがコミュニティで採用されるようになれば、今後、その他多数の機能がリリースされるでしょう。
それでは!