rest-api.html

<!--
@license
Copyright 2015 Anton Platonov <platosha@gmail.com>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<link rel="import" href="../polymer/polymer.html">
<link rel="import" href="rest-api-resource.html">

<!--
An element providing declarative data bindings to REST API.

Example:

    <rest-api url="http://localhost:3000">
      <rest-api-resource name="books" collection="{{books}}"></rest-api-resource>
    </rest-api>

### AJAX Transport Elements

Transport element is an `<iron-ajax>` or a compatible element that is used by
the `<rest-api>` element to perform the API requests.

By default, the internal `<iron-ajax>` instance is used by `<rest-api>`.

You can override the default internal transport by placing a custom transport
element, that has `rest-api-resource` element, to the light DOM contents of
`<rest-api>`.

The transport placed in the parent `<rest-api>` or `<rest-api-resource>` are
also used by the nested `<rest-api-resource>` elements.

In the following example, the `<custom-transport>` element is used as a
transport for the entire API:

    <rest-api url="http://localhost:3000">
      <custom-transport rest-api-transport></custom-transport>
      <rest-api-resource name="books" collection="{{books}}"></rest-api-resource>
    </rest-api>

This example uses the default transport to query the “books”, but the custom
transport is assigned for the “authors” collection.

    <rest-api url="http://localhost:3000">
      <rest-api-resource name="books" collection="{{books}}"></rest-api-resource>
      <rest-api-resource name="authors" collection="{{authors}}">
        <custom-transport rest-api-transport></custom-transport>
      </rest-api-resource>
    </rest-api>

See the [RestApi.AbstractTransportBehavior](#RestApi.AbstractTransportBehavior)
API documentation page for the custom transport elements API.

@demo
@demo demo/json-server.html
-->
<dom-module id="rest-api">
  <template>
    <iron-ajax id="ajax" content-type="application/json" bubbles></iron-ajax>
    <slot></slot>
  </template>
</dom-module>

<script>

  Polymer({

    is: 'rest-api',

    properties: {

      /**
       * REST API root url.
       */
      url: {
        type: String,
        notify: true
      },

      /**
       * Default set of request parameters used in all API requests.
       *
       * Inherited by child `rest-api-resource` elements.
       */
      params: {
        type: Object,
        notify: true
      },

      /**
       * Default set of request headers used in all API requests.
       */
      headers: Object,

      /**
       * Allow the use of query parameters on other requests than GET requests.
       */
      allowNonGetParams: {
        type: Boolean,
        value: false
      },

      /**
       * The model id attribute name. Used for model get and save API requests.
       *
       * Inherited by child `rest-api-resource` elements.
       */
      idAttribute: {
        type: String,
        value: 'id'
      },

      /**
       * Disable send any data changes to the API.
       *
       * Inherited by child `rest-api-resource` elements.
       */
      readOnly: Boolean,

      /**
       * Enable bubbling for `error`, `request` and `response` events.
       *
       * Inherited by child `rest-api-resource` elements.
       */
      bubbles: Boolean

    },

    get _transportElement() {
      return this.queryEffectiveChildren('[rest-api-transport]') || this.$.ajax;
    }

  });

</script>