要件定義の不安をなくす。要件定義の不安をなくす。ユニファのバックエンド分割に学ぶイノベーションメタバース開発に必要な技術の基本知識をおさらい。Boost」など、さまざまなカンファレンスを企画・運営しています。BOOKS(コードジン・ブックス)は、CodeZineの連載からカットアップした、開発現場の課題解決に役立つ書籍シリーズです。APIの新しいモジュールを作成します。前述のサンプルモジュールに含まれる機能ではありますが、empテーブルの社員情報を操作するAPIを作成してきます。API管理のホームページで[Create]ボタンをクリックします。API管理のホームページで[Create]ボタンをクリックモジュール作成のフォームに遷移します。Module」セクションにあるパラメーターのみですが、このフォームではその配下のURIテンプレートとハンドラーを同時に1つ作成できるようになっています。Module」セクションのみ設定します。モジュール作成のフォームNameこのモジュールの名前です。ここでは「社員」とします。Prefixこのモジュール配下のURIテンプレートに共通する接頭辞(Prefix)です。ここでは設定しません。Sharing)設定です。このモジュールのAPIへのアクセスを許可するドメインを指定します。ここではどのドメインからでもアクセスを許可するため「*」とします。PrivilegeこのモジュールのAPIへのアクセスを許可する権限です。Privilege」のままとし、このモジュールのAPIアクセスには認証を不要とします。Module]ボタンをクリックします。これでモジュールが作成されました[2]。Allowed」が一度では保存されませんでした。Change]ボタンで保存してください。続けて、このモジュール配下にURIテンプレートを作成していきます。全社員リストを取得するためのURIテンプレートを作成してみましょう。Template」をクリックします。Templateは「employee/list」とします。他のパラメーターはひとまずデフォルト値のまま[Create]ボタンをクリックします。次に、このAPIコールで実行されるクエリー(Query)を設定するためのハンドラーを作成します。Handler」をクリックします。APIコールで実行されるクエリー(Query)を設定するためのハンドラーを作成ハンドラーで特に重要なのはMethodとSourceです。ハンドラーの設定Methodこのハンドラーに対応するHTTPメソッドを指定します。APIの慣習としてデータを取得するAPIの場合はGETメソッドが用いられますので、今回もそれに習って「GET」とします。Type実行するアクションを指定します。今回はSQL文で複数レコードを取得するため「Query」とします。Formatレスポンスのフォーマットを指定します。ここでは「JSON」とします。AccessHTTPSによるアクセスを強制するかどうかを指定します。ここでは「Yes」とします。Size1回のAPIコールで取得できるレコード数を指定します。この値を設定した場合、超加したレコードについては、レスポンスに含まれる「next」属性で指定されているURLにアクセスすることで、再帰的に取得することができます。ここではデフォルトのまま未設定とします。Source実行するSQL文を指定します。ここではempテーブルの全レコードを取得するため、次のSQL文を設定します[3]。末尾にセミコロンを入れるとAPIコール時にエラーとなるので注意してください。全社員情報を取得するためのAPI設定が完了しました。画面下の方に[Test]ボタンが用意されています。このボタンをクリックすると、このAPIにブラウザでアクセスして結果を確認することができます。設定が正しく行われていれば、結果が次のようにJSONフォーマットで表示されます。設定されていればJSONフォーマットで結果を表示なお、ここでは単純に全件取得のクエリーを設定しましたが、SQL文によって、検索結果はいかようにもカスタマイズできます。カズキ)日本オラクルのエバンジェリスト。Platformに関するエンジニアリングと啓蒙活動を担当。クラウドのビルディングブロックを使ったモダンなアプリケーションの開発、エコシステムの構築をライフワークにしている。公私ともに何かを開発していることが多い。3.12」の最初のベータ版がリリース新着記事一覧を見るイベント今後の予定を見るCodeZineは、株式会社翔泳社が運営するソフトウェア開発者向けのWebメディアです。「デベロッパーの成長と課題解決に貢献するメディア」をコンセプトに、現場で役立つ最新情報を日々お届けします。イラストの無断転載を禁じます。記載されているロゴ、システム名、製品名は各社及び商標権者の登録商標あるいは商標です。