翻訳: WebAPI 設計のベストプラクティス - Qiita
これは Enchant の開発者である Vinay Sahni さんが書いた記事「Best Practices for Designing a Pragmatic RESTful API」1を、ご本人の許可を得て翻訳したものです。 RESTful な WebAPI を設計しようとすると、細かなところで長考したり議論したりすると思います。また、他の API に倣ってやってはみたものの、本当にそれでいいのか、どうしてそうしているのか分からない、何てことも少なくはないと思います。 この記事では、そのようなハマリどころについて Vinay さんなりの答えを提示し、簡潔かつ明快に解説してくれています。 今後 WebAPI を設計される方は、是非参考にしてみてください。 なお、誤訳がありましたら編集リクエストを頂けると幸いです。 まえがき アプリケーションの開発が進むにつれて、その WebAPI を公
WebAPIでエラーをどう表現すべき？15のサービスを調査してみた - Qiita
2017-01-05 追記 2016年3月にエラーの標準形式RFC7807「Problem Details for HTTP APIs」が提案され、今日現在proposed standard(標準化への提唱)となっています。こちらも是非ご覧ください。 RFC 7807 - Problem Details for HTTP APIs HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様 最近はREST APIを提供しているサービスが増えてきていますね！また公開されるAPIだけでなく、Microservicesなアーキテクチャを採用して、バックエンドがWeb APIで通信するケースも増えてきているように思います。 APIを使うときはあまり気にしたこともなかったですが、いざAPIを設計してみるとどんなインターフェイスがいいのか、どんな形式がいいのかといった疑問が次々と出てきます。
WebAPIリクエスト仕様書としてcurlコマンドのご提案 - Qiita
WebAPIの仕様を記述する方法はいくつかあると思う。 普通に日本語で記述する JSON Hyper-Schema、WADL、RAML、Swaggerなどを使う 仕様書の代わりにプログラムを書く HTTPメッセージそのものを記述しておく でも、文法にばらつきがあったり、読みにくかったり、ツールのセットアップが面倒だったり、どれもイマイチな所があって、手軽な方法が欲しいと思っていた。 何気なくcurlコマンドのオプションを調べていたら、「もうこれでAPIドキュメント扱いにしちゃえばいいんじゃね？」と思えてきたのでメモしておく。 curlコマンドのおさらい curlコマンドはlibcurlの付属コマンドで、最近のUnix系OSなら大抵最初から入っていると思う。コマンドの詳細はmanを読んでいただければ。 cURL - How To Use （マニュアルページ日本語訳） curlコマンドのオプシ
Amazon APIで複数・除外キーワード検索 | lazynotes
Amazon APIでジャンルをALLにして検索する時は、キーワード検索しかできません。 PHPを使って複数キーワードによるAND／NOT検索をしようとしたら色々つまずいたので、調べてみた。 Amazonに投げるリクエストはこんな感じ（前後に付ける署名等はとりあえず省略）。 http://ecs.amazonaws.jp/onca/xml?…&Keywords=カポーティ クリスマス&… この「カポーティ クリスマス」という日本語文字列を普通にURLエンコードすれば良いのかと思ったら、ちょっと違うっぽい。 公式によれば以下の通り。 B) パラメータ名と値を、以下のルールに従ってURLエンコードします。 ・RFC3986で規定された非予約文字はURLエンコードしてはいけません。非予約文字とは、A-Z, a-z, 09-, ハイフン(-)、アンダーバー(_)、ピリオド(.)およびチルダ
YOLP(地図) - Yahoo!デベロッパーネットワーク
Yahoo! Open Local Platform（YOLP）は、Yahoo!マップがデベロッパー向けに提供する地図・地域情報のAPI・SDKです。ウェブページの制作はもちろん、スマートフォン向けアプリケーションの開発においても、多彩な地図表示、店舗・施設検索、ジオコーディング、ルート検索、標高データ取得などの豊富な機能をご活用いただけます。 お知らせ 地図・地域情報の検索 Yahoo!ローカルサーチAPI 全国の店舗、イベント、クチコミ情報などの地域・拠点情報を検索できます。 Yahoo!ジオコーダAPI 住所をキーワードとして検索し、その位置情報を提供します。 Yahoo!リバースジオコーダAPI 指定の地点の住所情報を取得する機能を提供します。 その他の便利ツール 気象情報API 指定した緯度経度の降水強度実測値と予測値を取得できます。 郵便番号検索API 郵便番号を指定して、位置
RESTのベストプラクティス | POSTD
現在ではREST APIはとても一般的な話題です。ほとんどすべてのWebアプリケーションの一部分となっています。シンプルで一貫性があり実際的なインターフェースは必須です。これは皆さんのAPIを他の人が使うことをとても容易にします。皆さんにとってはRESTの実践が日常的に感じられるかもしれませんが、RESTをあまり尊重しない人々もよく見かけます。これがRESTについて投稿するきっかけでした。 この記事にはRESTfulなAPIを設計する時に考慮すべきベストプラクティスがあります。 注意 : ここでのベストプラクティスは、私が過去の経験に基づいて良いと考える事例です。もし違う考えをお持ちであれば、お気軽にメールをくだされば意見交換できると思います。 APIのバージョンを示す APIのバージョンは必須であるべきです。これがあると時間が経ってAPIが変わっても影響を受けません。その方法の1つはUR
#13 フロントエンド制作に華を！ 面白いWebAPI 7選 - KAYAC engineers' blog
こんにちは。 カヤックに新卒で入社し、フロントエンドエンジニアとして スロット制作を中心とした活動を続けている田島です。 どうぞお手柔らかによろしくお願いします。 さてさて、Webのフロントエンドエンジニアの場合、 何か作りたいアイデアを思いついてから世に公開するまでのスピードが コピーライターに次いで早いです。 また、リッチなコンテンツや大量のコンテンツを扱って何かしようというときには WebAPIをうまく活用すれば、自前でデータベースを作らずとも ササッと作って公開することもできます。 今回は、そうしたフロントエンド制作を豊かにするWebAPIの中から特に 面白いと思うものを7つ選び、実例を交えて紹介していきたいと思います。 1. MediaWiki API http://ja.wikipedia.org/w/api.php Wikipediaの情報を取得できるAPIです。 このAPI
「api.rakuten.co.jp」で提供しているAPIの廃止について - 楽天ウェブサービスブログ
日ごろ楽天ウェブサービスをご利用いただきありがとうございます。 「api.rakuten.co.jp」で提供している古いAPIにつきましては、 2014年8月末から、段階的に廃止することを予定しております。 皆様には大変お手数をおかけいたしますが、 「app.rakuten.co.jp」で提供している新バージョンAPIへの利用切り替えをお願いいたします。 今後は新バージョンのAPIにのみ機能追加、新ツールの提供を行う予定です。 ※現在、用意されてないAPIについては順次リリースを行ってまいります。 以下、廃止対象のバージョンを含むAPIのリストです。 ■楽天市場系API 楽天商品検索API Version（2010-09-15）Version（2010-08-05）Version（2010-06-30）Version（2009-04-15）Version（2009-02-03）Versio
「Yahoo!ショッピング」がAPIを開放--約50種類を無料で
ヤフーは3月12日、通販サイト「Yahoo!ショッピング」に関する約50本のAPIを無料で公開したことを発表した。主に「プロフェッショナル出店」をしている法人ストアが対象となり、4月以降には個人ストアや、スマホで構築できる「ライト出店」を選んだ法人ストア向けにも公開する予定。 ヤフーは2013年10月にYahoo!ショッピングのストア出店料と売上手数料の無料化を発表。その後も、新たなストア構築ツールの公開やシステム改修など合計100以上の施策を実施してきたそうだ。今回、Yahoo!ショッピングのプラットフォームを開発者に開放することで、モールとしての利便性を高めるなどして、サービスをさらに活性化させていきたい考えだ。 開発者は、これまでYahoo!ショッピングが提供する専用ツールで行っていた、出品管理、在庫管理、ページデザインなどをAPI経由で管理、作成できるようになる。これらのAPIは「
APIのバージョニングは限局分岐でやるのが良い - Hidden in Plain Sight
ちょっと前にTwitterでAPIのバージョニングをどうやるかみたいな話をしていたのですが、そのへんもやもやしているので少し整理しておきたいなと。 APIのURLを/api/v1/*とかってやるの、やめたほうがいいとおもうんだけどなぁ。いざv2を作るとなったときに、大量のコピペが発生して後悔するよ、って伝えたい。— Kenn Ejima (@kenn) February 28, 2014 さて、これについて色々と異論・反論も含めた意見が出たのですが、まずは、大昔にURL方式（＝コントローラ分割）でやってきて後悔したぼくが、（5年ぐらい前から）現在はどうやってAPIのバージョンを管理しているか？について紹介します。 基本原理としては、コピペが多発する根っこで分岐（＝コントローラ分割）じゃなくて、必要最小限のところで限局的に分岐するのがいい、という考え方に基づきます。 一言でいうと、「パラメー
ニコニコ動画APIとは (ニコニコドウガエーピーアイとは) [単語記事] - ニコニコ大百科
ニコニコ動画API単語 ニコニコドウガエーピーアイ 3.4千文字の記事 33 0pt ほめる 掲示板へ 記事編集 概要公式API非公式API API利用ツール等外部リンク関連項目脚注掲示板ニコニコ動画API とは、ニコニコ動画で利用可能なAPI （Application Programming Interface）である。 概要 中の人曰く、 [1] 現時点でも様々な方法でニコニコ動画内の情報（動画情報やサムネイルなど）を取得している方がいると思いますが、これも思ったより負荷がかかるので心情的にはやめてほしいというのが正直なところです。できれば負荷の少なそうな時間帯にやってもらえるとありがたいです、こっそりと。 最終的には他のサービスと同様にニコニコ動画内の情報を提供するAPIというのは用意していく予定で、具体的なスケジュールはまだ未定ですが年内にはいろいろできてるんじゃないかと思います。
![ニコニコ動画APIとは (ニコニコドウガエーピーアイとは) [単語記事] - ニコニコ大百科](https://cdn-ak-scissors.b.st-hatena.com/image/square/5bd1fac8d544d19340796767c18bdf23d7d3493d/height=288;version=1;width=512/https%3A%2F%2Fdic.nicovideo.jp%2Fimg%2Fog_b.jpg)
日本の全エンジニアに捧ぐ！現在公開されているAPI一覧【2013年版】 | Find Job ! Startup
2013年のいま、API界隈が熱い！ 今年に入り、官公庁の統計データやNHKの番組情報など、今までなかなか利用できなかったデータがAPIとして扱えるようになってきました。このエントリでは現在公開されているAPIを一覧でまとめます。いま使えるAPIはこれだけ読めば大丈夫。2013年の最新マッシュアップ事情をあますとこなく網羅します！ HOT! API 総務省 次世代統計利用システム（国勢調査、人口推計、就業構造、企業統計、物価統計 etc.） NHK番組表（※未公開） 行政・自治体・公共サービス 郵便番号 郵便番号検索API（郵便番号 → 住所） 郵便専門ネット（郵便番号 → 住所、郵便番号の簡易存在チェック） ぽすたん（郵便番号 → 住所、住所 → 郵便番号） IW3 PROJECT（郵便番号 → 住所、住所 → 郵便番号） 宇宙 Google+ JAXA PR（※現在一部の学生に限定公開
Social IME ～みんなで育てる日本語入力～
Xoi Lac TV – Xem Bóng Đá Trực Tiếp Hôm Nay – Xoilac TV Trực Tuyến Xoilac TV là kênh phát sóng trực tiếp các trận đấu thể thao lớn trên thế giới hoàn toàn miễn phí. Đến với Xoilac, khán giả được thỏa sức lựa chọn và theo dõi những trận đấu mà bản thân yêu thích. Ngoài ra, Xôi Lạc TV cũng cung cấp những thông tin hữu ích liên quan đến trận đấu để các bet thủ có thể dễ dàng đưa ra những nhận định chí
【19日目】WebAPIにアクセスして取得できるJSON処理についての3つのTIPS - 40歳からのキャリアチェンジ
この記事はあすとろなんとか@astronaughts さん主催のTitanium Mobile Advent Calendar 2012 向けに書いています。 TitaniumAdvent Calendarもう全部埋まったと思い込んでいたら明日と明後日が空いてるのにちょっとビックリ。「WebAPIにアクセスして取得できるJSON処理についての3つのTIPS」というネタ書こうと思っていたけどTIPが２個しかないからなぁ。。— hiroshi oyamada (@h5y1m141) December 18, 2012 というのが背景にあって、書いてみました。 本題 Twitterに代表されるように最近のWebサービスではそのサービスのリソースにアクセスできるようにAPIが提供されており、WebAPIを活用したiPhoneアプリ開発をすることが比較的多くあるかと思います。 WebAPIを通じて取
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Instagram APIでwebサービスを作りたい全ての人に向けて書きました
WebAPIのこれまでとこれから
http://api-portal.nhk.or.jp/ja
WEB APIのURL設計のトレンドはこれだ！WEB APIのURL設計まとめ
NHK番組API
kakao