bambu-api 2.0.1

关于BAMBU API

这个包允许您轻松地将django模型公开到restful 可以以XML或JSON格式发送数据的终结点。

关于BAMBU TOOLS 2.0

这是名为bambu tools的工具集的一部分。它是从一个 将bambu的命名空间及其所有 其他的工具。如果要从之前的版本升级 2.0，请确保更新代码以使用bambu_api而不是 超过bambu.api。

安装

通过pip安装软件包：

pip install bambu-api

将其添加到您的INSTALLED_APPS列表：

INSTALLED_APPS = (
    ...
    'bambu_api'
)

将bambu_api.urls添加到urlconf:

urlpatterns = patterns('',
    ...
    url(r'^', include('bambu_api.urls')),
)

前缀应该保持为空，因为包公开了两个主url 茎：/api/，其中restful端点存在，并且/docs/ 找到每个端点的自动生成文档的位置。

基本用法

您可以定义像django admins这样的api端点，并在 类似的方式。

Teka the Django“polls”应用程序就是一个例子。在投票目录中， 您将创建一个名为api.py的文件。一个简单的api端点是 定义如下：

from bambu_api import ModelAPI, site
from myproject.polls.models import Question

class QuestionAPI(ModelAPI):
    pass

site.register(Question, QuestionAPI)

这将为Question模型注册QuestionAPI端点。 然后可以在/api/polls/question.json访问端点。

完整文档

完整的文档可以在 ReadTheDocs。

问题或建议？

在twitter（@iamsteadman）或visit my blog上找到我。