Project KEEP 体験：#2）チュートリアルとデモアプリ

Web アプリ素人が Domino 12.0.2 の新機能である Domino REST API（Project KEEP）を怖いもの見たさで触ってみた体験レポートの #2 です。

前回は、インストールを行いましたので、引き続きチュートリアルを進めましょう。基本的には、チュートリアルの流れに沿って進めて、理解を進めてもらえればよいかと思います。

ここでは、各セクションで自分が少し戸惑った点などをまとめます。皆さんの評価の参考にしていただければ幸いです。

テスト用のツールのインストール

Domino REST API に限らず、外部の Web サービスをテストする際にの活用する一般的なツールですので、すでに、インストール済みかもしれませんね。

入ってなければインストールしましょう。

Domino REST API の管理画面での操作

デモアプリのインストールと管理画面を開くまでの内容です。

まず、デモアプリの入手方法をチュートリアル内に発見できませんでした。いろいろ調べていると、英語版のチュートリアル内に発見しました。リンクをクリックすると、Resources というリンクがあるのでこの中に、demo.nsf のダウンロードリンクがあります。

続いて、デモアプリのインストールです。チュートリアルでは、Docker 版で記述しています。今回の環境は、Windows であったこともあり、ダウンロードした domo.nsf をノーツの機能のでサーバにコピーし、配置するだけのノーツ屋的対応をしましたが、特に問題はありませんでした。これなら事前に設計の署名もできますしね...

curl もしくは postman で REST API の操作

チュートリアルに沿って進めていると、うまくいかない点に出くわしました。「データベースの一覧の取得」がうなく動かないのです。

HCL テクニカルサポートの方にお世話になり、すぐに解決しました。原因は、このチュートリアルは Domino REST API の Early Access 版をベースにしており、ｖ1.0.5 とは、エンドポイントが変更されているのが原因でした。

なお、この点に関しては、現在はすでに修正済みです。迅速な対応ありがとうございます。

ちなみに、仕様変更については、以下にまとめられておりますので、必要に応じて参照してください。

HCL Domino REST API Documentation - What's New

こんな理由から別の評価に進んだので、「データベースの一覧の取得」がうまくいったことを確認して、このセクションはここで中断しました。

Swagger UI で操作する

チュートリアルに記載がある通り『Swagger UI は、API に関するドキュメントを確認しながら、動作を確認することができる UI 』です。

さらっと書いてあるので、はじめ何のことかよくわからなかったのですが、操作してみて驚きました。

ここには、API に関するドキュメントが一元管理されており、API コール時のパラメータや送信する Request Body（JSON）の説明やサンプルが表示されます。

これだけだとただのヘルプなのですが、Swagger UI では、表示されているパラメータやサンプルを修正でき、その場でコール、その結果を表示してくます。
これまで、Domino Designer ヘルプや Microsoft Learn ぐらいしか見てこなかったので、ドキュメントとテストツールが一体となって、インタラクティブに仕様の確認がことに驚き、効率的に理解できることに感動しました！

チュートリアルでそれを体験できるので是非お試しください。

ところで、Swagger UI とは、Domino REST API の専用ツールではなく、OpenAPI Specificatioinに従って記述された一般的なツールなんですね。WEB アプリの世界は進んでいますね...

OData の操作

最後のセクションが OData に関してです。Domino REST API 経由で Notes データを Export できる機能のようでなかなか便利そうです。

こちらは、少し独立した機能に見えるので、別の機会に評価したいと思います。

最後に

以上で、Domino REST API のチュートリアルのレポートは終了します。

次回からは、この経験を利用して、自作アプリを追加って REST API を体験したレポートを掲載します。

前回

Project KEEP 体験

次回