翻訳: WebAPI 設計のベストプラクティス - Qiita
これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。 この記事では、そのようなハマリどころについて Vinay さんなりの答えを提示し、簡潔かつ明快に解説してくれています。 今後 WebAPI を設計される方は、是非参考にしてみてください。 なお、誤訳がありましたら編集リクエストを頂けると幸いです。 まえがき アプリケーションの開発が進むにつれて、その WebAPI を公
RESTful APIで長い検索クエリを扱う - yuw27b’s blog
Webアプリケーション用のRESTfulっぽいAPI*1を作っていて、複雑な検索クエリを受け取る必要が出てきたときのメモです。 悩み RESTfulの原則に従うと、検索クエリを投げて結果の一覧を取得する、というリクエストは、 「リソースの取得」なので、GETを使うべきです。 /api/entries/?q=xxx とか /api/entries/?created=20161129&status=active みたいなURIになりますよね。 こんな感じで検索キーワードが1つ2つなら良かったのですが、 今回作っていたのが限定されたユーザー向けのアプリで、多少検索に時間がかかってもいいから複雑なクエリを投げたい、というのが要件でした。 こんなふうに検索条件を組み合わせられるようになっていました。 問題は、 ①検索条件がいくつ来るか分からない ②「q=xxx」の形式では「equals」「not e
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
