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

persistence.xmlのプロパティについて

JavaEEではデータベースとの設定情報はpersistence.xmlに記述します。 (ユーザー名、パスワード、ポート、driver名、データベース名などの情報はglassfish-resource …

no image

Mapからインスタンス変数、インスタンス変数からMapへ

Javaで変数を引き回すときにMapからインスタンス、インスタンスからMap、あるインスタンスから別のインスタンスに変数を差し替える作業って結構多いと思います。 これって普通にやるとMapのget,p …

no image

CDIの循環依存エラー&JSFでの条件分岐について

本日は小ネタなので2つのネタをまとめます。 Contents1 CDI循環依存エラー2 JSFでの条件分岐 CDI循環依存エラー 半年近くやってますが、いまだにJavaEEでエラーがでてくると焦ります …

no image

型情報の取得・活用について

Javaで抽象度の高い実装を行うときに必要となる型情報の活用法について。 できるとできないとでプログラムの応用範囲が変わってくるのでメモっときます。 こちらのエントリーと合わせて読むといいと思います。 …

no image

Fileのアップロード

業務でCSVのアップロードを行っていますが、ファイルになりますと当然文字列ではなく、バイナリ形式のデータが必要になります。 アップロード自体の処理を書いていなかったので、その扱い方についてちょっと書い …