monospace blog

django-pistonでRestfulなWebAPIを簡単につくる

先日Twitterでつぶやいてたdjango-pistonですが、グーグル先生に聞いても日本語の記事はほとんど見つからなかったんで、わたくしが書いてみようと思います。

django-piston はもともとBitbucketのWebAPIのために作られた(多分)もので既存のDjangoのモデルを利用して簡単にRestfulなWebAPIが作れるという代物です。個人的には、いつか使ってみようと思いながら機会がなかったんですが、最近iPhoneアプリ作ってて、サーバ側の実装に使えそうだと思ったので使ってみました。

主な機能としては、

• RestfulなWebAPIっぽく、GET POST PUT DELETE を受けれる
• 1時間に50回までとかAPI呼出回数の制限をデコレータでつけられる
• ベーシック認証とOAuth認証に対応
• ドキュメント生成
• Djangoのformを利用したバリデーション

今回は、だいぶ前に @soundkitchen 氏に作ってもらったこのブログを使って実験してみます。ちなみにこのブログのソースは bitbucket にて公開しはじめました。場当たりでDjangoのバージョンアップにだけ対応してきたのでちょっと古いコードとかもありそうだし、いろいろいじりたいと思ってます。

今回の動作サンプルはこちら

そしたらこのブログのエントリーを取得できるようなAPIを書いてみます。現在のエントリー部分のモデルは、↓のような感じです。とりあえずこの中からいくつかのフィールドを持ってくるようにしてみます。

class Entry(models.Model):
    """
    blog's entry.
    """
    title = models.CharField(_(u'title'), max_length=255, default=None)
    slug = models.SlugField(_(u'slug'))
    description = models.TextField(_(u'description'))
    comments_count = models.IntegerField(_(u'comments count'), editable=False, default=0)
    trackbacks_count = models.IntegerField(_(u'trackbacks count'), editable=False, default=0)
    created_at = models.DateTimeField(_(u'created at'), editable=False, default=datetime.now)
    updated_at = models.DateTimeField(_(u'updated at'), editable=False)
    published_at = models.DateTimeField(_(u'published at'), editable=False, blank=True, null=True)
    is_published = models.BooleanField(_(u'is published'), default=True)
    is_active = models.BooleanField(_(u'is active'), default=True)
    tags = models.ManyToManyField(Tag)

とりあえず、django-pistonのインストール。最新版は0.22なんですが、これだとDjango1.2以降でPOSTするときにCSRF用のトークンがないって言われて動かないのでtip版の0.23rc1を使ってます。

まずは、プロジェクトのルートにapiというディレクトリとurls.py、handlers.py をそれぞれ作成します。

$ mkdir api
$ touch api/__init__.py
$ touch api/urls.py
$ touch api/handlers.py

次に、プロジェクトルートのurls.pyに手を加えます。

(r'^api/', include('api.urls')),

これを追記して、/api/以下へのアクセスは、api/urls.pyに丸投げしましょう。そして、api/urls.pyの中身は↓のような感じ。

from django.conf.urls.defaults import *
from piston.resource import Resource

from api.handlers import EntryHandler

entry_resource = Resource(EntryHandler)

urlpatterns = patterns('',
    (r'^posts/$', entry_resource),
    (r'^post/(?P<entry_id>\d+)/$', entry_resource),
)

EntryHandlerはこれからapi/handlers.pyに書くやつです。ここでは、/api/posts/ に来たときと /api/post/1/ とかに来たリクエストをさばく設定をしました。そして、api/handlers.py は↓な感じ

#vim:fileencoding=utf8
from piston.handler import BaseHandler

from blog.models import *


class EntryHandler(BaseHandler):
    """
    ブログのエントリーを返す
    """
    allowed_methods = ('GET',) # GETだけ受けつける
    fields = ('title', 'description', 'created_at', 'updated_at', 'get_absolute_url', 'tags') # 取得したいフィールド
    exclude = () # 除外するフィールド(これを空にしておかないとデフォルトでは、idが省かれる)
    model = Entry # モデル

    def read(self, request, entry_id=None):
        """
        entry_idがある場合は単一のエントリー。
        なければ最新の10個。
        """
        if entry_id:
            try:
                instance = Entry.objects.get(pk=int(entry_id))
            except Entry.DoesNotExist:
                return rc.NOT_FOUND # 404 を返すショートカット
        else:
            return Entry.objects.all()[:10] # 10個もってくる
        return instance

とりあえずこんな感じで動きます。GETのリクエストを受けるのがreadメソッドとかPOSTを受けるのが、createメソッドとかっていう決まりがあるんですが、今回はとりあえずGETだけ受けつけるようになってます。ちなみに、デフォルトではJSONでレスポンスが返るんですが、/api/posts/?format=xml とかするとXMLで返してくれます。

今回は疲れたのでここまでで、次はPOSTとかPUTとかDELETEも受け付けてみようと思います。

ブログ復活しようと思いました

かれこれ1年半ぶりくらいでしょうか。おそらく名古屋から関東に来てからは一度も書いてないような気がします。

まあそんなことはどうでもいいんですが、最近はWebデザイナーという肩書だったことの面影もなく、WebアプリとかiPhoneアプリの開発がメインのお仕事になっています。そろそろ、仕事に追われすぎて世の中から置いていかれるのはよろしくないということで、再度ブログを書くあたりから復活しようという次第です。今後は、引き続きDjango関係とiOSアプリとかその他どうでもいいことについても書いていこうかと思っております。またよろしくお願い致します。

どうやらDjangoのバージョンあげたらブログがおかしくなったので、なんとかするのが最初のタスクのようです。

iTermに乗り変えたついでにScreenも入れなおして256色対応にした

iTerm は特に使う理由がないと思ってたのでスルーしてたんですが、ふと思い立って入れてみました。別に重かったりもしないし割といいなーと思ってたら、Terminal で決定的に問題だった、set ambwidth=double が効かない問題がなんと iTerm では解決できていたのでさっさと乗り換えることにしました。

set ambwidth=double が効かない問題っていうのは、Terminal から Vim を使ってると set ambwidth=double にしても、□とか◯とかって文字がマルチバイト扱いしてもらえなくて、結果的にその後の文字とカーソルがずれるっていう問題です。これは HTML なんかを書いてると致命的で、仕方なくそのために gVim を起動してたりしてたわけです。

ついでに前々から gVim ではなくて Vim でも、シンタックスカラーリングをカラフルにしたいなあと思いつつ我慢してたわけですが、なにげに こんなエントリー を見つけたので早速導入してみました。

これで、256色対応って書いてあるカラースキームなら使えるようになります。本家 vim.org でも検索するとそれなりに見つかります。 拙作の monochrome.vim も対応しようかな。(見にくいとかマジレスされても困りますからね)

[追記: 09/03/17 01:49] iTerm + screen + vim での色設定

256色に変換するプラグインがあったんですなー！

CappuccinoのloggingをFirebugに

Cappuccino をぼちぼち攻めて行くわけですが、とりあえずデバッグ的なところから。

Cappuccino はクライアントサイドのフレームワークなので基本的に開発環境は、エディタとブラウザです。で、今や HTML や CSS を書くにしても Javascript を書くにしても必須なのが Firebug です。そこで、 Cappuccino でも使いたいのですが、その方法についてメモしておきます。

Cappuccino には CPLog という logging の機能があって、 よくある fatal error warn info trace 的なものを出力することができます。まずは

CPLogRegister(CPLogConsole);  // LogProvider を CPLogConsole に設定
CPLog.trace([label stringValue]); // trace 出力
CPLog.fatal([label stringValue]); // fatal 出力

とりあえず一通り出力して見ると、Firebug に以下のように表示されます。

こんな感じに表示されるので、困ったときはとりあえず表示してみるってことで一安心ですね。なんとか開発を進めていけそうです。

参考にしたのは、本家の こちらの Wiki です。他にもポップアップウィンドウで出す方法とか独自の LogProvider を作成するって方法もあるみたいです。

Atlasの発表で分かるCappuccinoの本気

先日マイアミの方で、 Future Of Web Apps というイベントがあったようです。そこで、 Cappuccino(Objective-J) の開発者から新しいサービスの発表がありました。

発表内容は以下の記事参照。スクリーンキャストあり。

• http://cappuccino.org/discuss/2009/02/28/announcing-atlas/
• http://thinkvitamin.com/features/atlas-under-the-hood/

Atlas というサービスで、夏頃のリリース予定なのだそうですが、次世代の Web UI 開発を感じさせてくれました。簡単に言ってしまうと、 Apple のソフトウェア開発環境である XCode を Cappuccino を使って、Web 上で実現したものと言えると思うのですが、いわゆるオンラインで Web UI を開発できる既存のサービスと Atlas とは決定的に目指すところが違います。それは、Cappuccino というフレームワークが XHTML だとか CSS だとか Javascript だとかそういうものの1段階上の層での Web UI の開発を実現している点です。

現状の Web UI の制作だと、HTML のコーディングのことを考えてデザインをしないといけないとかよくありますよね。ここにドロップシャドウつけたら、おそろしくめんどくさくなるとか。それテーブルレイアウトでおkって時代もあったけど、今 XHTML でのマークアップとかセマンティック Web とかって言われてます。でもそれって Web UI の未来にとってうれしいことなのか正直疑問です。ものすごくきれいに HTML や CSS が書ける人がいても得するのはせいぜい一緒に仕事する人くらいでしょう。なんかそういう部分から離れて、使う側から考えた Web UI を作れる方が楽しくなると思うんですよね。まあ、XHTML Valid のバナーが誰にとって得かって話です。

いつになってもなくならない IE6 問題とか、いつ普及するのか、もしくはほんとに完成するのかもよく分からない HTML5 とか CSS3 の実装状況がどうとか、もはやそういうのは低レイヤーになってしまったんです。なってしまってほしいです。Atlas がその理想形とは言いませんが、現状を見ると、楽しい Web UI の開発の未来はこういうところにあるのではないかなあ。

とたまには語ってみるのでした。まあ、Cappuccino には Objective-Jを覚えないといけないという最大の壁がありますからねｗ でも、XHTML+CSS+Javascript = Objective-J なわけで、これから学ぶなら一つだけ分かればオッケーっていう方がいいですよね。今後こういうコンセプトのものが増えてきたら面白いなあと思いました。

Python東海 第5回のまとめと発表資料公開します

[追記:2009/02/23 15:23] 今回も 株式会社 Vish 様のセミナールームをお借りしました。ほんといつもお世話になってます。

Cappuccinoのビルドとインストール

なんか Cappuccino ばっかやってた1日なので無駄にしないようにメモ。ビルドとインストールとかいうと、なんでそんなものが必要なのかと思うわけですが、あると便利とかそういう話なのでしなくても動かせます。

$ steam create hello

Cappuccino Web Framework についてそろそろ…

ちょっと前に話題になったけど、そろそろみんな忘れてるであろう Cappuccino Web Framework についてちょっと書いておこうかと。ちなみに自分も忘れてて久々に思い出しただけですが… とりあえず、Google 先生に聞いても、ほぼ発表当時の記事しかない状況だったので、復習しておきましょう。

Djangoでファイルアップロードのエラー

Python 旅館に来ています。過去にはまったことはメモっておくべきと思ったので、マメにブログに書いていこうと思いました。

とりあえず、 ImageField を含む適当なモデルを書いて、管理画面から追加したところ、画像のアップロードができません。というエラーの話。

環境は、MacOSX 10.5 Python2.5.1 Django1.0.2 です。

エラー内容は、「画像をアップロードしてください。アップロードしたファイルは画像でないか、または壊れています。」というもの。このエラーを django/conf/locale/ja/LC_MESSAGES/django.po から探すと、 django/forms/fields.py に書いてあるとのこと。なるほど、とりあえずPILが認識できない画像があがってくると、このエラーメッセージが出るっぽい。

要するに Python Image Library が JPEG を扱えなかったようですね。

$port install jpeg

Port で Jpeg 操作用のライブラリをインストールして、 PIL のインストールをし直して完了。その際に PIL の setup.py install でできた build ディレクトリとか消した方がいいですね。無事にアップロードできました。

Python東海 第4回

まずは、毎度のごとく会議室を使わせて頂いて差し入れまで頂いている 株式会社Vish 様と aodag 様に感謝致します。

今回は、8名参加ということでいつもよりちょっと少なめな感じなんですが、自分の発表以外は割と充実した内容でした。というのも自分は aodag 氏が来るまでの時間つぶしに Django の布教でもしようかとちょっとだけ紹介したんですが、Python2.6とPython2.5がわけわからんことになってて変なところでつまづいてしまったので、きっとマイナス効果だったことでしょう。言い訳としては、普段ローカル(Mac)でDjangoの開発をしていないということで。やっぱりいずれ Django 勉強会@名古屋はやりたいです。今んとこ自分的に無理ですけど。