Django 新增 tastypie API endpoint

本篇記錄如何在 Django 的 tastypie 套件中增加自己的 API endpoint 。

主要是透過覆寫 prepend_urls 的方式。

範例：

from tastypie.utils import trailing_slash
from tastypie.resources import ModelResource

from django.conf.urls import url


class MyResource(ModelResource):
    class Meta:
        ...

    def prepend_urls(self):
        return [
            url(r'^(?P<resource_name>{})/my_new_api{}$'.format(
                    self._meta.resource_name,
                    trailing_slash()
                ),
                self.wrap_view('my_new_api'), name='my_new_api'),
            )
        ]

    def my_new_api(self, request, **kwargs):
        self.method_check(request, allowed=['post'])
        self.is_authenticated(request)
        self.throttle_check(request)

        # do things here

        self.log_throttled_access(request)
        return self.create_response(request, your_response)

上述範例主要定義一個 my_new_api method ，然後在 prepend_urls 中加入新的 url ，就能夠做到增加新的 API endpoint 。

範例中的 self.method_check(request, allowed=['post']) , self.is_authenticated(request) , self.throttle_check(request) , self.log_throttled_access(request) 可以視需求自己增減，但建議基本的 self.method_check(request, allowed=['post']) 與 self.is_authenticated(request) 最好是要放著(安全考量)。

詳細請看 文件

p.s. 記得不要使用 override_urls ，因為這個 method 在官方文件中指出會在 v1.0.0 後被移除。