skillup

技術ブログ

Java

JAXRSによるRESTAPI作成方法

投稿日:2015年6月30日 更新日:

業務で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

arquillianでの外部ライブラリ使用

現状、実務ではDBのテストでは基本的にarquillianを使っています。 arquillianとにかく、重いですね~。 まあglassfishを動かしているので仕方ないかもしれませんが、簡単なテスト …

no image

小ネタ集

最近覚えた小ネタをのせていきます。 熟練のプログラマからすると当たり前のことが多いと思いますが・・・ Contents1 {}でスコープ限定2 リダイレクト:face-redirect=true3 H …

no image

JavaでのSQLの書き方

ちょっと小ネタです。 通常SQLを記述する場合、縦に分けて書くのが見た目にも見やすく、保守性も高いです。 例として

と書くよりは、 [ …

no image

JSFのifタグ

JSFは基本的にテンプレートなので、 HTML+CSS+JavaScript ロジック側からの変数の出力 ループ処理 以上のことをさせることはあまりありません。 が、まれに条件分岐なんかをさせたいとき …

no image

Javadocに関して

業務で社内で使うクラスライブラリを作成中です。 他人に使ってもらうものなのでコメントやドキュメント周りの整備が必要になり、javadocをしっかり作りたいと思っています。 Contents1 java …