django-formapi 0.2.0

安装

在python环境中安装django formapi

$ pip install django-formapi

将formapi添加到INSTALLED_APPS设置中。

INSTALLED_APPS=(...'formapi',)

将formapi.urls添加到url.py。

urlpatterns=patterns('',...url(r'^api/',include('formapi.urls')),)

用法

继续创建一个calls.py。

classDivisionCall(calls.APICall):"""
    Returns the quotient of two integers
    """dividend=forms.FloatField()divisor=forms.FloatField()defaction(self,test):dividend=self.cleaned_data.get('dividend')divisor=self.cleaned_data.get('divisor')returndividend/divisorAPI.register(DivisionCall,'math','divide',version='v1.0.0')

只需创建一个类似于常规django表单但继承自APICall的类。定义api调用的字段 应该收到。当字段被验证并且返回的内容将是json编码的时候，调用action方法 作为对api调用方的响应。API.register调用将APICall类作为第一个参数，第二个参数是 api调用应该驻留在namespace中，第三个参数是调用的name，第四个参数是version。 这将产生一个形式为api/[version]/[namespace]/[call_name]/的url，因此我们将得到/api/v1.0.0/math/divide/。

使用参数{'dividend': 5, 'divisor': 2}的有效调用将导致此响应：

{"errors":{},"data":5,"success":true}

参数为{'dividend': "five", 'divisor': 2}的无效调用将导致此响应：

{"errors":{"dividend":["Enter a number."]},"data":false,"success":false}

身份验证

默认情况下，APICalls已打开hmac身份验证。通过在APICall上设置signed_requests = False禁用它。

如果没有禁用，api的用户将不得不对其调用进行签名。为此，他们需要生成一个secret，通过django创建一个APIKey。 管理界面。保存时，将为api用户生成个人secret和key。

要为DivisonCall构建调用签名，请创建按键dividend=5&divisor=2排序的调用参数的查询字符串。使用sha1散列函数创建hmac。 python中的示例：

importhmacfromhashlibimportsha1hmac_sign=hmac.new(secret,urllib2.quote('dividend=5&divisor=2'),sha1).hexdigest()

对DivisionCall的签名请求将具有参数{'dividend': 5, 'divisor': 2, 'key': generated_key, 'sign': hmac_sign}

文档

访问/api/discover获取注册api调用的简要文档。