Django 新增 tastypie API endpoint

Posted on  Jun 25, 2016  in  Django  by  Amo Chen  ‐ 1 min read

本篇記錄如何在 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 後被移除。

FOLLOW US

對抗久坐職業傷害

研究指出每天增加 2 小時坐著的時間,會增加大腸癌、心臟疾病、肺癌的風險,也造成肩頸、腰背疼痛等常見問題。

然而對抗這些問題,卻只需要工作時定期休息跟伸展身體即可!

你想輕鬆改變現狀嗎?試試看我們的 PomodoRoll 番茄鐘吧! PomodoRoll 番茄鐘會根據你所設定的專注時間,定期建議你 1 項辦公族適用的伸展運動,幫助你打敗久坐所帶來的傷害!

贊助我們的創作

看完這篇文章了嗎? 休息一下,喝杯咖啡吧!

如果你覺得 MyApollo 有讓你獲得實用的資訊,希望能看到更多的技術分享,邀請你贊助我們一杯咖啡,讓我們有更多的動力與精力繼續提供高品質的文章,感謝你的支持!