SimpleAPI 使用与安装指南

1. 安装指南

SimpleAPI 提供了多种安装方式，以下为推荐安装方式：

使用 pip 进行安装：

pip install --upgrade simpleapi

或者从 GitHub 源代码安装：

git clone git://github.com/flosch/simpleapi.git

安装 SimpleAPI 前，请确保系统中已安装以下依赖：

• Python 2.5 或更高版本
• simplejson（如果使用 Python 2.5 或更低版本）
• python-dateutil
• pyyaml（可选，用于 YAML 支持）
• sphinx（可选，用于文档）

2. 项目使用说明

SimpleAPI 是一种简单、一致、透明且可移植的 API 提供方式。它支持多种传输格式（如 json、jsonp、xml、yaml），并提供服务器（独立、Django、Flask、Google AppEngine 等）和客户端库（Python、PHP）以实现无缝交互。您还可以使用几乎所有 AJAX 框架（如 jQuery、ExtJS 等）来访问 API。

服务器支持

• Django
• Flask
• Google AppEngine

客户端支持

• Python
• PHP
• JavaScript

3. 项目 API 使用文档

SimpleAPI 提供了丰富的 API 方法，以下为部分示例：

SMS-System

服务器端（handler.py）

from simpleapi import Namespace, serialize
from models import SMS, APIUser

class SMSAPI(Namespace):
    __authentication__ = lambda namespace, access_key: APIUser.objects.filter(access_key=access_key).count() > 0

    def send(self, to, msg, from='testsender'):
        sms = SMS.objects.create(
            to=to,
            msg=msg,
            from=from
        )
        return {
            'sent': sms.send(),
            'obj': serialize(sms, excludes=[re.compile('^date'),])
        }
    send.published = True
    send.constraints = {'to': re.compile(r'^\+\d{2,}\ \d{3,}\ \d{5,}')}
    
    def status(self, id):
        return SMS.objects.get(id=id)
    status.published = True
    status.constraints = {'id': int}
    
    def last(self, numbers=5):
        return SMS.objects.all()[:numbers]
    last.published = True
    last.constraints = {'numbers': int}

客户端（Python）

from simpleapi import Client

client = Client(ns='http://remote.tld:8888/api/', access_key='mysecret', transport_type='xml')

sms = client.sms(to='555123', msg='Hey yo! This is simpleapi calling.')
print "Sent successful?", sms['sent']

Calculator

服务器端（handler.py）

from simpleapi import Namespace

class CalculatorAPI(Namespace):
    __ip_restriction__ = ['127.0.0.*',]
    __authentication__ = "lets_calc"
    
    def power(self, a, b):
        return a ** b
    power.published = True
    power.constraints = lambda namespace, key, value: float(value)
    
    def sum(self, **kwargs):
        return sum(kwargs.values())
    sum.published = True
    sum.constraints = lambda namespace, key, value: float(value)

客户端（Python）

from simpleapi import Client

client = Client(ns='http://remote.tld:8888/api/', access_key='lets_calc')

print "5 ** 8 =", client.power(a=5, b=8)

4. 项目安装方式

SimpleAPI 提供多种安装方式，以下为两种常见安装方法：

使用 pip 安装

pip install --upgrade simpleapi

从 GitHub 源代码安装

git clone git://github.com/flosch/simpleapi.git