開発環境で作ったアプリを運用環境にデプロイしてみよう 前編

フォローする

(著者:サイボウズ 北川 恭平

今回は、2015年7月のアップデートで実装されたデプロイを効率化させるAPIの使い方について紹介したいと思います。

はじめに

kintoneはアプリの設定変更が即時に適用される性質上、大規模な開発となると開発環境と運用環境を用意して運用する場合があるかと思います。
そんな時に、これまでは開発環境のアプリの変更結果を手作業で運用環境にデプロイしなければいけませんでした。

そこで、2015年7月より実装されたAPIを利用することによって、運用環境にスムーズにアプリをデプロイすることができるようになります。
本Tipsは、前編で開発環境に作成したアプリの情報取得を紹介し、後半で運用環境にデプロイする方法を紹介します。

開発環境は、cybozu developer networkから開発者ライセンスを取得いただくか、新たに別環境をご用意ください。

イメージ図

APIを使ってデプロイ

それでは、アプリの設定と変更に従いAPIを使ってデプロイをしてみたいと思います。
アプリのデプロイに関連したドキュメントは、REST API (アプリ)を参照します。

開発環境にアプリを作成する

まずは開発環境に、以下のサンプルアプリを画面上から作ります。

フォームの設定

フィールド名 フィールドタイプ フィールドコード
ToDo Title 文字列(1行) Title
Details 文字列(複数行) Details

一覧の設定

 

作成し終えたら忘れずに、「設定完了」を押しましょう。

作成したアプリ

作成したアプリの情報をAPIで取得する

今回は、curlコマンドを使ってAPIリクエストを送信してみます。
TODO_SAMPLEアプリにはアクセス権とJavaScriptの設定していないので、次のAPIを実行します。

一般設定の取得

下記のコマンドを実行してみました。(ドメインはsample,アプリ番号は44,ユーザーはAdministrator,パスワードはCybozuの場合。以下コマンドは全てこの想定)

curl https://sample.cybozu.com/k/v1/app/settings.json -X GET -H 'content-Type:application/json' -H "X-Cybozu-Authorization: QWRtbmlzdHJhdG9yOmN5Ym96dQ==" -d '{"app":44}

レスポンスをみてみます。

アプリの説明はなにも入れていないので、ただのdivタグになっています。
アイコン情報、アプリ名、リビジョン、デザインテーマ情報が取得できました。

フォーム設定の取得

次に、フォームの設定情報を取得します。
まずは、フィールドの一覧を取得します。下記のコマンドを実行します。

下記のコマンドを実行してみました。

curl https://sample.cybozu.com/k/v1/app/form/fields.json -X GET -H 'content-Type:application/json' -H "X-Cybozu-Authorization: QWRtbmlzdHJhdG9yOmN5Ym96dQ==" -d '{"app":44}

レスポンスはというと…

なんだか思ったよりいろんなフィールドが返ってきましたね。自分で配置した、2つのフィールド以外にもkintoneに組み込まれているレコード番号や、作成者といったフィールドの情報も取得できました。

次に、フィールドのレイアウトを以下のコマンドを実行し、取得してみます。

curl https://sample.cybozu.com/k/v1/app/form/layout.json -X GET -H 'content-Type:application/json' -H "X-Cybozu-Authorization: QWRtbmlzdHJhdG9yOmN5Ym96dQ==" -d '{"app":44}

レスポンスを見ていきましょう。

違う行に2つのフィールドを並べたので、fieldsの配列が2つになっていますね。もし、同一行に2つのフィールドを並べた場合、fileds配列の中に左に並べてあるフィールドから順番に格納されます。

一覧設定の取得

下記のコマンドを実行してみました。

curl https://sample.cybozu.com/k/v1/app/views.json -X GET -H 'content-Type:application/json' -H "X-Cybozu-Authorization: QWRtbmlzdHJhdG9yOmN5Ym96dQ==" -d '{"app":44}

これは分りやすいですね。ビュー名「Default」の情報が取得できました。

後編にづづく

以上でアプリの作成に必要な情報は取得できました。後半では、この情報を元にAPIをつかってアプリを作成していきたいと思います。

開発環境で作ったアプリを運用環境にデプロイしてみよう 後編>>

 

このTipsは、2015年7月版で確認したものになります。

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

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

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