【Spring MVC】REST APIにて基本的なXMLまたはPDFを返却する方法
概要 REST APIアプリにて、XML情報またはPDF情報を返却する方法についてまとめた。 前提 動作確認はTalend API Testerを使用した。 Talend API Testerの使用方法については以下を参照。 基本的なXML返却 返却したいxmlファイルを参照し、バイナリ情報に変換して返却する。 XMLの用意 「src/main/resou […]
概要 REST APIアプリにて、XML情報またはPDF情報を返却する方法についてまとめた。 前提 動作確認はTalend API Testerを使用した。 Talend API Testerの使用方法については以下を参照。 基本的なXML返却 返却したいxmlファイルを参照し、バイナリ情報に変換して返却する。 XMLの用意 「src/main/resou […]
概要 REST APIアプリにて、web.xmlを使用して例外ハンドリングを行う方法についてまとめた。 Webアプリケーションの設定 例外がアプリ側でハンドリングされず、サーブレットコンテナ(Tomcat)まで伝播する場合、web.xmlを利用して例外ハンドリングを行う。 web.xml 例外の種類に応じて、エラー時の挙動を設定できる。 今回は特定のエラー情報がサーブレ […]
概要 REST APIアプリにて、任意の例外をハンドリングする方法についてまとめた。 前提 動作確認はTalend API Testerを使用した。 Talend API Testerの使用方法については以下を参照。 任意の例外ハンドリング リソース検索時、検索結果が0件の場合は例外をスローする。 アプリ側でスローされた例外をエラーハンドリングクラスで取得し、任意のエラ […]
概要 REST APIアプリにて、エラーメッセージをカスタマイズする方法についてまとめた。 以下の記事の続きとなる。 前提 動作確認はTalend API Testerを使用した。 Talend API Testerの使用方法については以下を参照。 エラーメッセージをカスタマイズ メッセージソースを使用して、外部ファイル(プロパティ)からメッセージ内容を取得する。 メッ […]
概要 REST APIアプリにて、入力チェックを行った際のエラーハンドリング方法についてまとめた。 エラーメッセージはBean Validationのデフォルトメッセージを使用する。 前提 動作確認はTalend API Testerを使用した。 Talend API Testerの使用方法については以下を参照。 基本的な入力チェックエラーハンドリング Response […]
概要 REST APIアプリにて、入力チェックを行う方法についてまとめた。 尚、入力チェックエラーハンドリング方法は扱わない。 前提 動作確認はTalend API Testerを使用した。 Talend API Testerの使用方法については以下を参照。 基本的な入力チェック サーバーリクエスト時の、クエリパラメータまたはリクエストボディのBean Validati […]
概要 Rest APIアプリを作成し、GET通信でリソース検索を行う方法についてまとめた。 基本的なリソース検索 GETリクエストで送られるクエリパラメータを取得し、リソース検索を行う。 クエリパラメータは個別に取得するケースと、オブジェクトのフィールドにバインドさせて取得するケースがある。 Bean Validationなどの入力チェックを使用できるため、今回はオブジェクトで取得す […]
概要 REST APIアプリを作成し、DELETE通信を行う方法についてまとめた。 事前準備 リソース削除用の処理と、リソース削除後の全リソース取得用の処理をサービスクラスに追加する。 サービスクラス リソース削除用のdeleteメソッド、全リソース取得用のfindAllメソッドを追加する。 ResourceService.java package com […]
概要 REST APIアプリを作成し、JSONを使用してPUT通信を行う方法についてまとめた。 事前準備 リソース更新用の処理をサービスクラスに追加する。 サービスクラス リソース更新用のupdateメソッドを追加する。 ResourceService.java package com.example.rest_prototype.biz.service; […]
概要 REST APIアプリを作成し、JSONを使用してPOST通信を行う方法についてまとめた。 事前準備 クライアントから送られるJSONを受け取るリクエストクラスの用意と、リソース登録用の処理をサービスクラスに追加する。 リクエストクラス Resourceクラスとフィールドは同じとなる。 後々、Bean Validation用のアノテーションを追加していく。 &nb […]
概要 REST APIアプリを作成し、GET通信を行う方法についてまとめた。 ※以下の記事の続きとなる。 事前準備 サービスクラスにリソースを返却するメソッドを追加する。 サービスクラス キーに紐づくリソースの取得を行うfindメソッドを追加する。 ResourceService.java package com.example.rest_prototyp […]
概要 これから数回にかけてREST APIについて学んだことを載せていく。 今回はREST APIの仕組みとプロジェクト作成方法について紹介する。 尚、RESTとは何かということについては取り扱わない。 仕組み 前提として、作成するREST APIアプリはJSON形式でクライアントと疎通を行うこととする。 クライアントサーバー間が疎通する全体像は以下のようになる。 &n […]