Page Contents

概要

LoopBackのモデルは自動的に、モデルのデータに対して作成・読取・更新・削除(CRUD)操作を行うREST APIを提供する、 標準的なHTTPエンドポイント一式を持ちます。 model-config.json ファイルの public プロパティは、モデルのREST APIを公開するかどうかを指定します。

/server/model-config.json

...
"MyModel": {
  "public": true,
  "dataSource": "db"
},
...

モデルのREST API を「隠す」には、単に publicfalse に変更します。

RESTパス

既定では、REST APIはモデル名の複数形としてマウントされます。具体的には以下のとおりです。

  • Model.settings.http.path
  • pluralモデル定義JSONファイルで定義されている場合)
  • 自動的に複数形に変換されたモデル名(既定)。例えば、location モデルがあった場合、既定では /locations としてマウントされます。

RESTルータを使う

既定では、土台を作ったアプリケーションは loopback.rest ルータを使って、モデルをREST経由で公開します。

手動で、loopback.rest ルータを使って、REST経由でモデルを公開するには、以下のようなコードを使用します。

/server/server.js

var app = loopback();
app.use(loopback.rest());

// `Product` モデルを公開する
app.model(Product);

After this, the Product model will have create, read, update, and delete functions working remotely from mobile. At this point, the model is schema-less and the data are not checked.

You can then view generated REST documentation at http://localhost:3000/explorer

LoopBackは、REST APIを持つ幾つかの組み込みモデルを提供しています。 詳細は、組み込みモデルのREST API を参照してください。

リクエスト形式

POST・PUTリクエストについては、リクエストボディはJSON・XML・URLエンコードされた形式が使えます。 Content-Type ヘッダは以下のいずれかにしてください。

  • application/json
  • application/xml
  • application/x-www-form-urlencoded

Accept ヘッダは、好ましいレスポンス形式を示します。

HTTPクエリ文字列を使って、JSONのオブジェクトや配列を渡す

幾つかのREST APIは、クエリ文字列にJSONオブジェクトや配列を受け取ります。LoopBackは、オブジェクトや配列の値をクエリパラメータとしてエンコードする方式を2つサポートしています。

  • node-querystring (qs) の文法
  • 文字列化した JSON

例えば以下のようなものです。

http://localhost:3000/api/users?filter[where][username]=john&filter[where][email][email protected]
http://localhost:3000/api/users?filter={"where":{"username":"john","email":"[email protected]"}}

以下のテーブルは、JSONオブジェクト・配列を異なる方式でエンコードする方法を説明しています。

JSON オブジェクト・配列 qs方式 文字列化したJSON
{
where: {
  username: 'john',
  email: '[email protected]'
  }
}
?filter[where][username]=john
&filter[where][email][email protected]
?filter={
  "where": {
    "username":"john",
    "email":"[email protected]"
  }
}
{
  where: {
    username: {inq:
      ['john', 'mary']}
  }
}
?filter[where][username][inq][0]=john
&filter[where][username][inq][1]=mary
?filter={
  "where": {
    "username": {
      "inq":["john","mary"]
    }
  }
}
{
  include: ['a', 'b']
}
?filter[include]=a&filter[include]=b
?filter={
  "include": ["a","b"]
}

レスポンス形式

全てのリクエストのレスポンス形式は通常、ボディ部にJSONオブジェクト・配列またはXMLと、ヘッダ一式からなります。 レスポンスによってはボディは空です。

HTTP/1.1 200 OK
Access-Control-Allow-Origin: http://localhost:3000
Access-Control-Allow-Credentials: true
Content-Type: application/json; charset=utf-8
Content-Length: 59
Vary: Accept-Encoding
Date: Fri, 24 Oct 2014 18:02:34 GMT
Connection: keep-alive

{"title":"MyNote","content":"This is my first note","id":1}

HTTPステータスコードは、リクエストが成功したかどうかを示します。

  • ステータスコード 2xx は成功を表します。
  • ステータスコード 4xx はリクエスト関連の問題を表します。
  • ステータスコード 5xx はサーバ側の問題を表します。

エラーに対するレスポンスは、以下のようなJSON形式になります。

例えば以下のようになります。

{
  "error": {
    "message": "could not find a model with id 1",
    "stack": "Error: could not find a model with id 1\n ...",
    "statusCode": 404
  }
}

Disabling API Explorer

LoopBack API Explorer is great when you’re developing your application, but for security reasons you may not want to expose it in production.

For an application using loopback-component-explorer, to disable explorer in production:

  • Set the NODE_ENV environment variable to “production”.
  • Then in server/component-config.production.json:

server/component-config.production.json

{
  "loopback-component-explorer": null
}

事前に定義されたリモートメソッド

既定では、背後にデータソースが存在するモデルについては、 LoopBackは標準的な作成・読取・更新・削除(CRUD)操作を全て備えたREST APIを公開します。

LoopBackが公開するREST APIを説明するための例として、 Location(営業拠点を表します)と呼ばれる単純なモデルを考えます。 LoopBackは自動的に、いくつものRESTエンドポイントに対応するNodeのメソッドを作成します。

以下の表は、LoopBack 3.x にて公開されるリモートメソッドのリストです。

モデル (Node) API HTTPメソッド パスの例
create() POST /locations
replaceOrCreate() PUT /locations
patchOrCreate() PATCH /locations
exists() GET /locations/:id/exists
findById() GET /locations/:id
find() GET /locations
findOne() GET /locations/findOne
destroyById() or deleteById() DELETE /locations/:id
count() GET /locations/count
replaceById() PUT /locations/:id
prototype.patchAttributes() PATCH /locations/:id
createChangeStream() POST /locations/change-stream
updateAll() POST /locations/update
replaceOrCreate() POST /locations/replaceOrCreate
replaceById() POST /locations/:id/replace

ご覧の通り、既定の設定でLoopBack 2.x と 3.0 の違いは HTTP PUTエンドポイントの振る舞い( PUT /api/my-models と PUT /api/my-models/:id の両方)だけです。LoopBack 2.x の既定では、これらのエンドポイントは patch メソッドを呼出して部分的な更新を行っていましたが、LoopBack 3.0 では、これらのメソッドは完全な置き換えを実行します。

replaceOnPUT フラグ

replaceとupdateメソッドの振る舞いを変更するには、 model.json  内の replaceOnPUT プロパティを使用します。もし、replaceOnPUT が trueならば、replaceOrCreate と replaceById がHTTP PUT メソッドを使用し、false ならば、updateOrCreate と updateAttributes/patchAttributes が HTTP PUT メソッドを使用します。

以下は、location.json にて replaceOnPUT を設定する方法のサンプルです。

...
{
  name: "location",
  plural: "locations",
  relations: {},
  acls: [],
  properties: {  },
  replaceOnPUT: true
}...

モデル・メソッド・エンドポイントの公開と隠蔽

モデルをREST経由で公開するには、/server/model-config.json ファイルの public プロパティを true にセットします。

...
"Role": {
  "dataSource": "db",
  "public": false
},
...

メソッドとRESTエンドポイントの隠蔽

幾つかの操作を公開したくない場合、モデルで disableRemoteMethodByName() を呼び出すことで、それらを隠蔽できます。 例えば、以下に示すサンプルは、規約によって common/models/location.js に書かれるべきものです。 事前定義されたリモートメソッドの一つを「隠蔽」するには、以下のような行を追加します。

common/models/location.js

Location.disableRemoteMethodByName('deleteById');

これで、deleteById()メソッドと対応するRESTエンドポイントは外部から利用できなくなります。

updateAttributes() のようにオブジェクトのプロトタイプに存在しているメソッドについては以下のようにします。

common/models/location.js

Location.disableRemoteMethodByName('prototype.updateAttributes');

これは、MyUser モデルにおいてloginlogout 以外の全メソッドを隠蔽する例です。

In server/model-config.json:

"MyUser": {
  "dataSource": "db",
  "public": true,
  "options": {
    "remoting": {
      "sharedMethods": {
        "*": false,
        "login": true,
        "logout": true
      }
    }
  }
}

config.json ファイルの remoting オブジェクトを通じて、全モデルに渡って共通のメソッドを隠蔽することもできます。

"remoting": {
  "context": false,
  ...
  "sharedMethods": {
    "*": false,
    "login": true,
    "logout": true
  }
}

代わりに、myUser.js モデルのJavaScriptを使って、リモートメソッドを無効化することもできます。

MyUser.disableRemoteMethodByName('create');
MyUser.disableRemoteMethodByName('upsert');
MyUser.disableRemoteMethodByName('updateAll');
MyUser.disableRemoteMethodByName('prototype.updateAttributes');

MyUser.disableRemoteMethodByName('find');
MyUser.disableRemoteMethodByName('findById');
MyUser.disableRemoteMethodByName('findOne');

MyUser.disableRemoteMethodByName('deleteById');

MyUser.disableRemoteMethodByName('confirm');
MyUser.disableRemoteMethodByName('count');
MyUser.disableRemoteMethodByName('exists');
MyUser.disableRemoteMethodByName('resetPassword');

MyUser.disableRemoteMethodByName('prototype.__count__accessTokens');
MyUser.disableRemoteMethodByName('prototype.__create__accessTokens');
MyUser.disableRemoteMethodByName('prototype.__delete__accessTokens');
MyUser.disableRemoteMethodByName('prototype.__destroyById__accessTokens');
MyUser.disableRemoteMethodByName('prototype.__findById__accessTokens');
MyUser.disableRemoteMethodByName('prototype.__get__accessTokens');
MyUser.disableRemoteMethodByName('prototype.__updateById__accessTokens');

読み取り専用エンドポイントの例

全てのPOST, PUT, DELETE 動詞を隠して、読み取り専用の操作だけを公開したいこともあるかもしれません。

common/models/model.js

Product.disableRemoteMethodByName('create');     // (POST) /products を削除
Product.disableRemoteMethodByName('upsert');     // (PUT) /products を削除
Product.disableRemoteMethodByName('deleteById'); // (DELETE) /products/:id を削除
Product.disableRemoteMethodByName('updateAll');  // (POST) /products/update を削除
Product.disableRemoteMethodByName('prototype.updateAttributes');
    // (PUT) /products/:id を削除
Product.disableRemoteMethodByName('createChangeStream');
    // (GET|POST) /products/change-stream を削除

関連するモデルのエンドポイントの隠蔽

関連するモデルのメソッドについて、RESTエンドポイントを無効化するには、disableRemoteMethodByName()を使用します。

例えば、投稿(Post)とタグ(Tag)のモデルがあったとして、投稿は複数のタグを持ちます。以下のコードを /common/models/post.js に書くことで、 関連するモデルのリモートメソッドと、対応するRESTエンドポイントを無効化することができます。

common/models/model.js

module.exports = function(Post) {
  Post.disableRemoteMethodByName('prototype.__get__tags');
  Post.disableRemoteMethodByName('prototype.__create__tags');
  Post.disableRemoteMethodByName('prototype.__destroyById__accessTokens'); // DELETE
  Post.disableRemoteMethodByName('prototype.__updateById__accessTokens'); // PUT
};

プロパティの隠蔽

REST経由で公開されているモデルのプロパティを隠蔽するには、hidden プロパティを定義します。 モデル定義JSONファイル (Hidden プロパティ)を参照ください。