Backbone-tastypie 技术文档

1. 安装指南

首先，确保你的项目中已经安装了 Backbone.js (版本 1.0.0 或更新版本) 和 Underscore.js (版本 1.4.4 或更新版本)。

接着，将 backbone_tastypie 添加到你的 INSTALLED_APPS 设置中。然后，在你的基础模板中添加以下代码：

<script type="text/javascript" src="{{ STATIC_URL }}js/underscore.js"></script>
<script type="text/javascript" src="{{ STATIC_URL }}js/backbone.js"></script>
<script type="text/javascript" src="{{ STATIC_URL }}js/backbone-tastypie.js"></script>

2. 项目使用说明

Backbone-tastypie 是一个小的转换层，可以使 Backbone.js 和 django-tastypie 欢快地协同工作。它还兼容其他遵循相同风格的 REST API，例如 TastyMongo。

Backbone-tastypie 重写了 Backbone 的几个方法，以实现与 django-tastypie 的兼容性。这些方法主要与 Backbone.sync 相关，包括构建模型和集合的 URL，以及解析数据。

3. 项目API使用文档

3.1 全局API设置

Backbone-tastypie 在 Backbone.Tastypie 命名空间下支持几个全局API设置。

doGetOnEmptyPostResponse

默认值：true

默认情况下，Tastypie 在 POST 请求后不返回数据。启用此设置将执行一个额外的 GET 请求，从服务器获取新创建的模型的数据。如果你可以控制服务器，你也可以在您的（模型）资源上启用 always-return-data 选项。

doGetOnEmptyPutResponse

默认值：false

默认情况下，Tastypie 在 PUT 请求后不返回数据。启用此设置将执行一个额外的 GET 请求，从服务器获取更新后的模型的数据。如果你可以控制服务器，你也可以在您的（模型）资源上启用 always-return-data 选项。

apiKey

包含 username 和 key 的对象。

csrfToken

设置当前的 CSRF 令牌。更多信息请参阅 Django CSRF 文档。你也可以像这样从 cookie 中加载值（假设你已经安装了 jQuery.cookie 插件）：

Backbone.Tastypie.csrfToken = $.cookie( 'csrftoken' );

3.2 方法

Backbone.sync

重写 Backbone.sync 方法，以便在创建对象后（如果响应体为空，参考 doGetOnEmptyPostResponse）或更新对象后（参考 doGetOnEmptyPutResponse）执行额外的 GET 请求。

Backbone.Model.prototype.url

Backbone.Model.prototype.parse

Backbone.Collection.prototype.parse

Backbone.Collection.prototype.url

重写 Backbone.Collection.prototype.url 方法，使其能够为模型集合构建 URL。这在使用 Backbone-relational 的 fetchRelated 方法时特别有用。

4. 项目安装方式

请参考上述“安装指南”部分。

以上就是 Backbone-tastypie 的技术文档，希望对您的使用有所帮助。