simple_api 0.2.1

安装

使用pip安装：

pip install simple_api

…或从github克隆项目：

https://github.com/san4ezy/simple_api.git

1. 将simple_api应用程序添加到INSTALLED_APPS设置：

   INSTALLED_APPS = (
       ...
       'simple_api',
   )
   

2. 将包导入到“url.py”并将simpleapi连接到您的项目：

   import simple_api
   simple_api.connect()
   

3. 将simpleapi模式添加到urlpatterns：

   url(r'api/', include(simple_api.urls)),
   

4. 将名为api_models.py的文件生成到应用程序中，导入simpleapi包并为api创建自定义类

示例

让我们看一个如何使用simpleapi的快速示例。

我们将创建一些类，这些类使用simpleapi为项目的api生成方法。

编辑“api-models.py”：

import simple_api
from main.models import *

# This class makes a url http://your-domain/api/getprojects/
class GetProjects(simple_api.SimpleAPI):
    filter = simple_api.CharVariable(blank=True, default='active', choices=['all', 'active', 'not_active', ])
    mode = simple_api.CharVariable(blank=True, default='object', choices=['object', 'name', ])
    description = u"Getting projects data"

    def method(self):
        queryset = None
        if self.filter.case(0):
            queryset = Project.objects.all()
        elif self.filter.case(1):
            queryset = Project.objects.filter(active=True)
        elif self.filter.case(2):
            queryset = Project.objects.filter(active=False)
        if self.mode.case(0):
            return queryset
        elif self.mode.case(1):
            return [(x.pk, x.name, ) for x in queryset]

# This class makes a url: http://your-domain/api/projects__<method>/ , where "method" should be "get", "make", "edit" or "delete".
class Projects(simple_api.ModelAPI):
    model = Project