RESTAPIサンプル¶
robosteinでRESTAPIを作成する場合のサンプルフローです。
このサンプルフローでは単純に現在時刻を返すAPIとなっています。
サンプルフロー¶
[{"id":"85ed8bf0.c232f8","type":"comment","z":"bac93068.01bd1","name":"REST APIを作成","info":"IPの許可などをしないと動作しません。詳細については\nマニュアルを参考にしてください。\n","x":100,"y":180,"wires":[]},{"id":"75f4d125.976fd","type":"http in","z":"bac93068.01bd1","name":"","url":"/date/now","method":"get","upload":false,"swaggerDoc":"","x":130,"y":240,"wires":[["f9c539f4.902128"]]},{"id":"60b5853e.74f20c","type":"http response","z":"bac93068.01bd1","name":"","statusCode":"","headers":{},"x":510,"y":240,"wires":[]},{"id":"f9c539f4.902128","type":"function","z":"bac93068.01bd1","name":"現在時刻","func":"var dt = new Date();\nif( msg.req.query.timestamp ){\n dt.setTime( msg.req.query.timestamp );\n}\nmsg.payload = dt;\nreturn msg;","outputs":1,"noerr":0,"x":340,"y":240,"wires":[["60b5853e.74f20c"]]}]
上記を設置すると以下のようなフローが表示されます。
設定¶
RESTAPI(HTTPを受け付ける)として利用する場合、以下の確認が必要になります。
- URLを確認する
ロボシュタインの管理画面から「インスタンス一覧」画面を開き、「編集」ボタンを押します。
編集ボタンを押すと以下の画面が出てきますので、「APIは下記のURLになります」と記載しているURLをどこかにコピーします。
IPの制限
上記画面のように接続元のIPを制限する事も可能です。CIDR形式で記載してください。複数記載する場合は改行区切りで記載が可能です。記載の無い場合(空白の場合)は全て許可として扱われます。
アクセス方法¶
上記までで準備は整いました。
では実際にブラウザでアクセスをしてみてください。アクセスURLは
上記のURL+/date/nowとなります。
↓こんな感じです。(実際のURLは異なります。)
https://demo0001.nr.stg-robostein.io/api/date/now
アクセスすると、以下の画面のように現在日時が返ってくるのがわかるかと思います。
これを使って¶
このサンプルフローを参考にし、
- HTTPの受信をトリガーとしたフロー
- 簡易的なRESTAPIの作成
- 現在時刻を利用したフロー
など、パーツとしての利用やフロー作成の参考にしてください。