「kintone Utility Library for JavaScript」の使い方

フォローする

はじめに

今回は、2016年12月に(ひそかに)リリースされた、「kintone Utility Library for JavaScript」について紹介します。
「kintone Utility Library for JavaScript」とは、REST APIを使う上で、生産性を向上するために有志により開発されたライブラリです。
例えば、レコードの一括取得/更新/削除など、毎回記述するには面倒な処理を、よりシンプルに記述できます。
 
それでは、その使い方を説明します。

kintone Utility Library for JavaScriptのダウンロード

GitHubよりダウンロードいただき、アプリに添付してください。
 
またはは以下のURLをコピーして、URLで指定してください。
https://kintone.github.io/kintoneUtility/kintoneUtility.min.js
※ 本サンプルプログラムはMIT licenseにて提供しています。 

kintone Utility Library for JavaScriptの構造

kintoneUtilityオブジェクトには「rest」と「ui」※のプロパティがあり、それぞれに関数を持っています。
※「ui」は近日公開を目指し準備中となります。
 
「rest」で提供される関数
なお、詳細はreadmeをご確認ください。
・kintoneUtility.rest.getRecord
・kintoneUtility.rest.getRecords
・kintoneUtility.rest.getAllRecordsByQuery
・kintoneUtility.rest.postRecord
・kintoneUtility.rest.postRecords
・kintoneUtility.rest.postAllRecords
・kintoneUtility.rest.putRecord
・kintoneUtility.rest.putRecords
・kintoneUtility.rest.putAllRecords
・kintoneUtility.rest.deleteRecords
・kintoneUtility.rest.deleteAllRecords
・kintoneUtility.rest.deleteAllRecordsByQuery
・kintoneUtility.rest.upsertRecord
・kintoneUtility.rest.upsertRecords

サンプルコード

例:下記のアプリの「Numberフィールドが0より大きい全レコード」を取得するサンプルコードです。
 ・レコード番号                                                   : 529
 ・取得条件(query)                                               : "Number"フィールドが0より大きいレコード
 ・レスポンスに含めるフィールドコード(fields) : String,Number
 ・ゲストスペースではない
 
まず、「kintone Utility Library for JavaScript」を使わなかった場合、
Promiseを利用したモダンなアプリの全レコード取得の書き方」と同様にPromiseを使い再帰的にレコードを取得する必要があります。
 
「kintone Utility Library for JavaScript」を使わなかった場合
一方、「kintone Utility Library for JavaScript」を使うと、パラメータ(JSON)を指定するだけで、
全レコードを取得することができます。
 
「kintone Utility Library for JavaScript」を使った場合
この様にPromiseや再帰処理がなくなることによるコードの簡素化が実現できます。
また、すべてのレスポンスはPromiseオブジェクトで返されます。
  

最後に

「kintone Utility Library for JavaScript」は、皆さんの開発負荷を軽減できるよう、今後も機能を拡充していく予定です。
ぜひ、コメントでのフィードバックをお待ちしています。
 

関連記事

記事に関するフィードバック

直接的に記事と関連がないご質問はcybozu developer コミュニティをご活用ください。

ログインしてコメントを残してください。
Powered by Zendesk