skillup

技術ブログ

Java

JAXRSによるRESTAPI作成方法

投稿日:

業務でJavaによりWEBAPI(Rsetful API)を作成する機会ががあったのでちょっとメモしておきます。

RestAPIとは

近年、WEBサービスなどで使われているJavaのAPIは軽量さやシンプルさからRestに基づいて設計されたものが多くなってきています。

Restの特徴として、下記のようなものがあげられます。

  • URIによりリソースが特定される
  • HTTPメソッドを利用して、リソースを操作
  • クライアント、サーバー間はステートレス

リソース・・WEBからアクセスすることのできる1つ1つのファイル(ただのプログラムやテキストファイル)などのこと。

ステートレス・・1回きりの通信でそれまでの通信状態を保持しない状態のこと。対義語はステートフル(セッションに概念が近い)。

凄く単純に言ってしまうとあるURLをたたいた時に何らかのデータを返すサービスのことです。

またJavaにてRestfulAPIを作成する仕様のことをJAX-RSというようです。

プログラムの作成方法について

通常のAPIではデータベースにアクセスをして、その結果を返すということが一般的かと思います。

その場合の書き方です。

環境は
Windows8
Java7
Glassfish 4.1

です。

なお、一部のプログラムが前回の記事と同じです。

またアプリケーションサーバーを起動する場合下記のプログラムも必要になってきます。

上記のようなJavaのプログラムを作成し、

http://localhost:8080/プロジェクトファイル名/webresources/ping

と入力すると画面にJSON形式の配列が表示されます。

もちろんパラメータも渡せるようですが、次回以降書かせていただきます。

ちなみに「Javaエンジニア養成読本」を参考にしました。

 

-Java
-

執筆者:


comment

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

関連記事

no image

JPAでの多対多のリレーション

以前、このエントリーでJPAのリレーションについて説明しました。 今回は多対多について説明します。 Contents1 テーブル構成2 ソース2.1 CDのエンティティ2.2 Artistのエンティテ …

no image

例外処理について その2

以前、「例外処理について」で例外処理について記述をしたんですが、漠然としていたのともう1回まとめなおしたかったため、メモしておきます。 Contents1 例外とは?2 例外のクラス分け2.1 Thr …

no image

mavenでのjarファイル作成

ここ半年Javaを触っていますが、9割以上がWEBアプリでバッチ系のものを作る機会から外れていました。 今回バッチを作っており、IDEでは動くのにいざコンソールで動かそうと思ったら動かないということが …

no image

JPAでの算術関数の型&mavenコンパイルプラグイン

本日も小ネタなので2つ同時に扱います。 Contents1 JPAの算術関数2 mavenのコンパイル JPAの算術関数 JPAでは以前、MySQLなどと同じように算術関数を使えると書きました。 参考 …

no image

arquillianでのリソースファイル読み込み

以前、このエントリーでarquillianからライブラリが利用できず、追加のライブラリを導入した、ということを書きました。 実はリソースファイルもそのままですとarquillianからは使用できません …