REST API用のシンプルなAngularJSフロントエンド

REST

REST API用のシンプルなAngularJSフロントエンド

1. 概要

このクイックチュートリアルでは、単純なAngularJSフロントエンドからRESTfulAPIを使用する方法を学習します。

テーブルにデータを表示し、リソースを作成して更新し、最後に削除します。

2. REST API

まず、単純なAPIを簡単に見てみましょう–ページネーションを使用してFeedリソースを公開します。

改ページされる– * GET * / api / myFeeds？page = {page}＆size = {size}＆sortDir = {dir}＆sort = {propertyName}
作成– * POST * / api / myFeeds
更新– * PUT * / api / myFeeds / {id}
削除– *削除* / api / myFeeds / {id}

ここでの簡単なメモは、ページネーションが次の4つのパラメーターを使用していることです。

page：要求されたページのインデックス
size：ページあたりの最大レコード数
sort：並べ替えに使用されるプロパティの名前
sortDir：ソート方向

そして、Feedリソースがどのように見えるかの例を次に示します。

{
    "id":1,
    "name":"example feed",
    "url":"/feed"
}

3. フィードページ

次に、フィードページを見てみましょう。






Add New RSS Feed

    
        {{row.name}}
        {{row.url}}
        
            Edit
            Delete

データを表示するためにng-tableを使用したことに注意してください。これについては、次のセクションで詳しく説明します。

4. Angularコントローラー

次に、AngularJSコントローラーを見てみましょう。

var app = angular.module('myApp', ["ngTable", "ngResource"]);
app.controller('mainCtrl', function($scope, NgTableParams, $resource) {
    ...
});

ご了承ください：

ngTableモジュールを挿入して、ユーザーフレンドリーなテーブルにデータを表示し、ページ付け/並べ替え操作を処理するために使用しました
また、REST APIリソースへのアクセスに使用するためにngResourceモジュールを挿入しました

5. AngularJS DataTable

ng-tableモジュールを簡単に見てみましょう–構成は次のとおりです。

$scope.feed = $resource("api/myFeeds/:feedId",{feedId:'@id'});
$scope.tableParams = new NgTableParams({}, {
    getData: function(params) {
        var queryParams = {
            page:params.page() - 1,
            size:params.count()
        };
        var sortingProp = Object.keys(params.sorting());
        if(sortingProp.length == 1){
            queryParams["sort"] = sortingProp[0];
            queryParams["sortDir"] = params.sorting()[sortingProp[0]];
        }
        return $scope.feed.query(queryParams, function(data, headers) {
            var totalRecords = headers("PAGING_INFO").split(",")[0].split("=")[1];
            params.total(totalRecords);
            return data;
        }).$promise;
    }
});

APIは特定のスタイルのページネーションを想定しているため、テーブル内のそれをそれに合わせてカスタマイズする必要があります。 ng-moduleからparamsを使用し、ここで独自のqueryParamsを作成します。

ページネーションに関するいくつかの追加の注意事項：

params.page()は1から始まるため、APIと通信するときにインデックスがゼロになるようにする必要もあります。
params.sorting()はオブジェクト（たとえば\{“name”: “asc”}）を返すため、キーと値を2つの異なるパラメーター（sort、sortDir）として分離する必要があります。
応答のHTTPヘッダーから合計要素数を抽出します

6. その他の操作

最後に、ngResourceモジュールを使用して多くの操作を実行できます–$resourceは、使用可能な操作に関して完全なHTTPセマンティクスをカバーします。カスタム機能を定義することもできます。

前のセクションでqueryを使用して、フィードリストを取得しました。 getとqueryの両方がGETを実行することに注意してください。ただし、queryは配列応答の処理に使用されます。

**6.1. 新しいFeedを追加します**

新しいフィードを追加するには、次のように$resourceメソッドsaveを使用します。

$scope.feed = {name:"New feed", url: "http://www.example.com/feed"};

$scope.createFeed = function(){
    $scope.feeds.save($scope.feed, function(){
        $scope.tableParams.reload();
    });
}

**6.2. Feedを更新します**

次のように、$resourceで独自のカスタムメソッドを使用できます。

$scope.feeds = $resource("api/myFeeds/:feedId",{feedId:'@id'},{
    'update': { method:'PUT' }
});

$scope.updateFeed = function(){
    $scope.feeds.update($scope.feed, function(){
        $scope.tableParams.reload();
    });
}

PUTリクエストを送信するために独自のupdateメソッドを構成した方法に注意してください。

**6.3. Feedを削除します**

最後に、deleteメソッドを使用してフィードを削除できます。

$scope.confirmDelete = function(id){
    $scope.feeds.delete({feedId:id}, function(){
        $scope.tableParams.reload();
    });
}

7. AngularJsダイアログ

それでは、ngDialogモジュールを使用して、フィードを追加/更新するための簡単なフォームを表示する方法を見てみましょう。

これがテンプレートです。別のHTMLページまたは同じページで定義できます。

次に、ダイアログを開いてフィードを追加/編集します。

$scope.addNewFeed = function(){
    $scope.feed = {name:"New Feed", url: ""};
    ngDialog.open({ template: 'templateId', scope: $scope});
}
$scope.editFeed = function(row){
    $scope.feed.id = row.id;
    $scope.feed.name = row.name;
    $scope.feed.url = row.url;
    ngDialog.open({ template: 'templateId', scope: $scope});
}
$scope.save = function(){
    ngDialog.close('ngdialog1');
    if(! $scope.feed.id){
        $scope.createFeed();
    } else{
        $scope.updateFeed();
    }
}

ご了承ください：

$scope.save()は、ユーザーがダイアログのSaveボタンをクリックしたときに呼び出されます
$scope.addNewFeed()は、ユーザーがフィードページのAdd New Feedボタンをクリックしたときに呼び出されます–新しいFeedオブジェクトを初期化します（idなし）
$scope.editFeed()は、ユーザーがフィードテーブルの特定の行を編集するときに呼び出されます

8. エラー処理

最後に、AngularJSを使用してhow to handle response error messagesを見てみましょう。

サーバーエラー応答をリクエストごとではなくグローバルに処理するために、インターセプターを$httpProviderに登録します。

app.config(['$httpProvider', function ($httpProvider) {
    $httpProvider.interceptors.push(function ($q,$rootScope) {
        return {
            'responseError': function (responseError) {
                $rootScope.message = responseError.data.message;
                return $q.reject(responseError);
            }
        };
    });
}]);

そして、これがHTMLでのメッセージ表現です。


    {{message}}

9. 結論

これは、AngularJSからREST APIを使用する簡単な記事です。

このチュートリアルのfull implementationは、the github projectにあります。これはEclipseベースのプロジェクトであるため、そのままインポートして実行するのは簡単です。

TOC

REST API用のシンプルなAngularJSフロントエンド