[B! webapi][設計] y_yukiのブックマーク

「WebAPI 設計のベストプラクティス」に対する所感 - Qiita

「翻訳: WebAPI 設計のベストプラクティス」を読んで色々と思うところがあったので書きました。上記の記事は訳文でありますので、正しくは「Best Practices for Designing a Pragmatic RESTful API」に対する所感と述べた方が良いのかもしれませんが、日本語で通して読めるよう Qiita に投稿された訳文に対する所感として書いています。以下では「翻訳: WebAPI 設計のベストプラクティス」並びに「Best Practices for Designing a Pragmatic RESTful API」は「当該記事」と表現します。観点当該記事では「○○とした方がよい」との意見に対してそうすべき理由が明らかになっていないか、もしくは表現が曖昧な場合が目立っていると感じました。設計は実装のようにプログラム言語仕様が制約を与えられないため、意図

y_yuki 2016/03/30

リンク

翻訳: WebAPI 設計のベストプラクティス - Qiita

これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。この記事では、そのようなハマリどころについて Vinay さんなりの答えを提示し、簡潔かつ明快に解説してくれています。今後 WebAPI を設計される方は、是非参考にしてみてください。なお、誤訳がありましたら編集リクエストを頂けると幸いです。まえがきアプリケーションの開発が進むにつれて、その WebAPI を公

y_yuki 2016/03/25

リンク

WebAPIリクエスト仕様書としてcurlコマンドのご提案 - Qiita

WebAPIの仕様を記述する方法はいくつかあると思う。普通に日本語で記述する JSON Hyper-Schema、WADL、RAML、Swaggerなどを使う仕様書の代わりにプログラムを書く HTTPメッセージそのものを記述しておくでも、文法にばらつきがあったり、読みにくかったり、ツールのセットアップが面倒だったり、どれもイマイチな所があって、手軽な方法が欲しいと思っていた。何気なくcurlコマンドのオプションを調べていたら、「もうこれでAPIドキュメント扱いにしちゃえばいいんじゃね？」と思えてきたのでメモしておく。 curlコマンドのおさらい curlコマンドはlibcurlの付属コマンドで、最近のUnix系OSなら大抵最初から入っていると思う。コマンドの詳細はmanを読んでいただければ。 cURL - How To Use （マニュアルページ日本語訳） curlコマンドのオプシ