CookBook

Web API Maker を利用した API の作成方法

投稿日:

この CookBook では、Web API Maker を利用した API の作成方法 について紹介しています。
Web API Maker を利用したプログラミングは intra-mart Accel Platform Web API Maker プログラミングガイド に書かれていますが、この CookBook では簡易なサンプルプログラムを元に作成方法を紹介します。

完成イメージ


1. https://dev.intra-mart.jp/imart/im_cookbook/159976/get を開きます。
2. 以下のようなレスポンスが表示されます。(anonymous の部分はログイン時にはログインユーザコードが表示されます)

 

完成サンプル

以下の完成サンプルをダウンロードしてご活用ください。

e builder プロジェクト : im_cookbook_152112.zip
imm ファイル : im_cookbook_159976-1.0.0.zip

ローカル環境で表示させる場合は、以下のURLにアクセスしてください。
http://localhost:8080/imart/im_cookbook/159976/get
なおベースURLである以下の部分は、環境に合わせて適宜変更してください。
http://localhost:8080/imart

レシピ

  1. packages ファイルを作成します。
  2. ファクトリを実装します。
  3. サービスを実装します。
  4. サービスにアクセスします。

1. packages ファイルを作成します。

以下のような packages ファイルを作成します。

src/main/resources/META-INF/im_web_api_maker/packages

ファイルの中身はパッケージを書いた一行のみです。
packages ファイルは拡張子も付けません。

このファイルを配置することで、パッケージ「jp.co.intra_mart.cookbook.cookbook159976」配下にある @WebAPIMaker アノテーションが付与されたクラスが Web API Maker に認識されるようになります。
逆に言えば、これから作成するファクトリやサービスクラスはパッケージ「jp.co.intra_mart.cookbook.cookbook159976」配下に作成します。

2. ファクトリを実装します。

src/main/java/jp/co/intra_mart/cookbook/cookbook159976/MyServiceFactory.java

行数 説明
7 ファクトリクラスには @WebAPIMaker アノテーションを付与します。
9-12 ファクトリ生成メソッドを定義します。単に、自身のインスタンスを new して返却します。
14-17 サービス生成メソッドを定義します。単に、サービスのインスタンスを new して返却します。

3. サービスを実装します。

src/main/java/jp/co/intra_mart/cookbook/cookbook159976/MyService.java

行数 説明
9 このサンプルでは特別な認証処理を行わないため @IMAuthentication アノテーションを付与します。
11 この API の URL を http://localhost:8080/imart/im_cookbook/159976/get と定義します。
12 この API には GET でアクセスできるように定義します。
13 メソッド名は何でも構いません。戻り値に API の戻り値とした型を指定します。
14-16 サービスメソッドを定義します。この API では Hello {ユーザコード} を返却します。

3. サービスにアクセスします。

Java で定義した API の戻り値は String ですが、REST API の戻り値は json もしくは xml になります。
リクエストヘッダー Accept に application/json を指定した場合、json で返却され、application/xml を指定した場合 xml で返却されます。

Accept: application/json でアクセス

以下のような json が返却されます

Accept: application/xml でアクセス

以下のような xml が返却されます

このように単純な実装だけで、REST API を作成することが可能です。
是非ご活用ください。

-CookBook

執筆者:


comment

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

関連記事

no image

No.8 Excel からの一括ユーザ一括登録

この記事は、EWS 2017で行われたLogicDesignerの講演内容に関する記事です。 こちらの例では、LogicDesignerを利用して、入社や組織変更等の発生時に有用なExcelファイルの …

no image

IM-BloomMaker Modifier の使い方

このCookBookでは、2020 Summer から利用可能になった環境変数($env)に含まれる「modifier」について紹介しています。 modifier は、同じく 2020 Summer …

no image

Formaの実行画面でセッションを維持するには

このCookbookでは、IM-FormaDesignerの実行画面でセッションを維持する方法を記載します。 この方法を利用すると、通常は時間制限によりタイムアウトしてしまうログインセッションを、自動 …

no image

Payara 5.184 を Google Kubernetes Engine(GKE) から利用する

この CookBook では、Payara を GKE 上で実行しクラスタリングを構築する手順について紹介しています。 Payara 5.184 で Kubernetes Cluster Mode が …

IM-LogicDesignerを利用して、申請日が一定期間経過した特定フローの完了案件をアーカイブする

このCookBookでは、LogicDesignerを利用して、申請日が一定期間経過した特定フローの完了案件をアーカイブする方法について紹介しています。 完成イメージ 1. サンプルのロジックフローを …

RSSRSSRSSRSS