django-wapiti 1.0.3

关于

Django-wapiti是一个通用的API层，可以将它添加到任何django项目中，以允许其他应用程序通过JSON非常容易地访问其模型和方法。

它由Ecometrica开发，并在BSD许可证下开源。

用法

1. 安装django-wapiti。最简单的方法可能是使用

   pip install git+http://git@github.com/ecometrica/django-wapiti.git#egg=django-wapiti

2. wapiti需要装饰器模块才能正常工作

   pip install decorator

3. 将wapiti添加到您的django项目的settings.py文件中的INSTALLED_APPS

4. 从某个地方调用wapiti.helpers.register_models，通常是在您的urls.py中，以注册您的API模型和方法

5. 要使应用fooapp中的模型类Foo可通过API访问，创建一个包含以下内容的文件fooapp/api.py

   from wapiti.helpers import register
   from wapiti.modelapi import ModelApi
   
   from fooapp.models import Foo
   
   class FooApi(ModelApi):
       auto_complete_fields = ('name', 'description')
       auto_complete_order_by = 'name'
       model = Foo
   
   register('foo', FooApi)

   我们使auto_complete方法通过自动搜索字段name和description（因此必须在Foo模型定义中存在）上的不区分大小写的搜索来工作

   有关给定模型中ModelApi类所有选项的列表，请参阅文件wapiti/modelapi.py

6. 此时，所有类型为Foo的对象都可通过API在/api/1.0/foo/处访问。要使实例方法可通过API调用，请将其应用于wapiti.helpers.api_method装饰器。要调用ID为3的Foo对象的foo_method，您将执行GET /api/1.0/foo/3/foo_method

7. 类似地，对于类方法，只需用相同的api_method装饰它，但还要在上面的python classmethod装饰器中应用。要通过API调用Foo的foo_cls_method，您将执行GET /api/1.0/foo/foo_cls_method

8. 要通过API进行调用，您需要API密钥。从主django管理界面，点击添加APIKey，添加一个名称，并添加一个具有资源正则表达式.*的权限，方法为GET。所有API调用都需要一个带有有效和活动API键的k=THEAPIKEY参数。

9. 通过JSON进行的所有调用都必须有所有参数都是正确的JSON！这意味着要将字符串参数传递给方法，它需要用双引号括起来！有关详细信息，请参阅JSON规范。

10. 为了使用按IP限制，我们需要REMOTE_ADDR变量。如果您使用nginx，这需要在正确的location部分中

    fastcgi_param REMOTE_ADDR $remote_addr;

发布说明