HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様
今日では HTTP(s) で API が公開されることは当たり前の時代ですが、エラーをアプリケーションにどう伝えるかは、個々の API の設計に依存していました。特に、HTTP ステータスコードは有限であり、元々持っている意味があるので、自由に使うことはできません。API はそのドメインごとにもっと複雑で細かなエラー情報があるはずで、それらはレスポンスボディに載せてアプリケーションに伝えることになりますが、その書式に規定は今までありませんでした。 HTTP API にて、アプリケーションにエラー情報を伝達するための（レスポンスボディに載せられる）標準的な形式が、RFC7807 Problem Details for HTTP APIs で定められています。適用例としては、以下のようになります。 HTTP/1.1 403 Forbidden Content-Type: application
日本の行政機関等が公開しているAPIについてのまとめ（2016年8月17日暫定版。随時更新） - Qiita
Deleted articles cannot be recovered. Draft of this article would be also deleted. Are you sure you want to delete this article? この記事は下記のURLにあるコミックマーケット90で頒布した同人誌と自分が管理するブログの記事を微修正し、転載したものです。 南関東開発機構 : 同人誌「日本の行政機関が公開中のAPIについて調べてみた本」を公開しました http://blog.livedoor.jp/south_kanto_dm/archives/52143201.html 南関東開発機構 : 日本の行政機関が公開中のAPIについてのまとめ（2016年8月17日暫定版） http://blog.livedoor.jp/south_kanto_dm/archives/5
RESTfulなWeb APIを設計するときに考えること - Qiita
ApigeeやHerokuのドキュメントに従うのでもよかったんだけど、読んでいく中でやっぱり考えることは出てきたので、あくまで自分のための指針をまとめてます。 包括的なWeb API作成についての知見 HerokuのAPIデザイン | SOTA interagent/http-api-design · GitHub Web API 設計のベストプラクティス集 "Web API Design - Crafting Interfaces that Developers Love" - フリーフォーム フリークアウト Web API Design | Apigee NetFlixもWeb APIの設計についての知見をよく放出してくれてる印象。 設計の基本 基本は /コレクション/名詞 リソースの関係を表したい時に階層化する members/1234/friends 階層は浅く保つ できるだけ/c
apigeeのWeb API Designよんだ
なるほど URLには複数形の名詞で具体的な名前をつけましょうね 大抵の人がおそらく使うであろうRESTful APIはGETメソッドだろうとのことでURLの名称は複数形の名詞にしておくのが自然。 ただし、複数のリソースを含んでしまうような名前は避けないとダメ。 それから、/itemsとか/assetsみたいな抽象的な名称も避けないといけない。/itemsというリソースにはおそらくブログや動画が含まれうるから。 関連性はシンプルに リソースはほとんどの場合が別のリソースと関連している。では、そういう時どうやってシンプルさを保つか。 犬には飼い主がいるだろう。なので次のようにできる。 GET /owners/5678/dogs POST /owners/5678/dogs こんな風にしていくといくらでもリソースの階層が深くできてしまう。 そこで知っておきたいのは主キーが決まってしまえば情報は特
Instagram API
MetaのInstagramプラットフォームは、ビジネスがInstagramユーザーとやり取りしやすくなるツールを提供しています。 Instagramログインを使ったAPIにより、アプリのユーザーは自分のInstagramビジネスアカウントおよびInstagramクリエイターアカウントのデータにアクセスできるようになります。このAPIを使えば、ビジネス/クリエイターとそのビジネス/メディアに興味があるInstagramユーザーとの間でメッセージを送受信したり、メディアを取得/公開したり、メディアに対するコメントの管理/返信、他のInstagramユーザーから@メンションされたメディアの特定をアプリでできるようになります。Instagramビジネスアカウントかクリエイターアカウントが必要です。 Facebookログインを使ったInstagram APIによって、アプリのユーザーはFacebo
HTTP/2 on iOS
HTTP/2 was finalized earlier this year, published as RFC 7540 and is already integrated in iOS 9 and OS X El Capitan. Additionally Apple is pushing HTTP/2 aggressively by providing the new Apple Push Notification Service (APNs) only via HTTP/2 (WWDC Session 720 - What’s New in Notifications - starting ~16:40). HTTP/2 is a great step for the web and especially for mobile devices because it solves s
セマンティック バージョニング 2.0.0
セマンティック バージョニング 2.0.0 概要 バージョンナンバーは、メジャー.マイナー.パッチ とし、バージョンを上げるには、 APIの変更に互換性のない場合はメジャーバージョンを、 後方互換性があり機能性を追加した場合はマイナーバージョンを、 後方互換性を伴うバグ修正をした場合はパッチバージョンを上げます。 プレリリースやビルドナンバーなどのラベルに関しては、メジャー.マイナー.パッチ の形式を拡張する形で利用することができます。 導入 ソフトウェア・マネージメントの世界には、「依存性地獄」と呼ばれる恐ろしいものがあります。あなたのシステムが大きく成長すればするほど、さまざまなパッケージを組み込めば組み込むほど、自分が地獄の底にいることにいつか気づくでしょう。 多くの依存性を有しているシステムにとって、新しいバージョンがリリースされることは悪夢でしかありません。厳密に依存関係を指定し
APIデザインケーススタディ —— Rubyライブラリを移植する前に読む本 - 世界線航跡蔵
『 APIデザインケーススタディ 』という本を頂戴したので読んでみた。 ライブラリ作者に向けて この本はRuby標準ライブラリを題材にして、分かりやすく、多様な機能をサポートして、互換性を保つAPIの設計をするにはどのように考えるべきかを教えてくれる。 ここでAPIと言っているのは、一般的なRubyのクラスとオブジェクトとメソッドから成るライブラリをどうデザインするか、という話である。 別にChef RecipeやRSpec DSLのようなちょっと変わったDSLを設計するとかそういう話ではない。確かにその種の言語内DSLのデザインには固有のセンスが必要とされるし、 Ruby DSL Handbook なんて本が書かれているように実装にあたってもある種のテクニックが必要なのも確かだ。でも、それ以外の「ふつう」のライブラリのデザインは果たして簡単だろうか。 適切な粒度のクラスを定義する。必要な
Foursquare APIメモ - Qiita
自分用メモです。 参考資料 developer.foursquare.com https://developer.foursquare.com/docs/ Foursquare API プラットフォームおよびデータ使用ポリシー https://ja.foursquare.com/legal/api/platformpolicy FOURSQUARE LABS, INC. API およびデータライセンス契約 https://ja.foursquare.com/legal/api/licenseagreement API 開発者のための Foursquare 商標ガイドライン https://ja.foursquare.com/legal/api/trademarkusage リソース https://ja.foursquare.com/about/logos [foursquare Api]
foursquare APIでできること - Qiita
https://api.foursquare.com/v2/hoge/fuga ?param1=value1 ¶m2=value2 &client_id=YOUR_CLIENT_ID &client_secret=YOUR_CLIENT_SECRET &v=YYYYMMDD バージョニング すべてのリクエストには v=YYYYMMDD が必要です。foursquare APIは YYYYMMDD に指定した日付時点の仕様で動作します。例えば、v=20140208 を指定しておけば、2014年2月9日にfoursquare側で大幅な仕様変更があった場合も、2014年2月8日時点での仕様で動作し続けるため、突然アプリケーションが動かなくなった！ということを防げます。 https://developer.foursquare.com/overview/versioning 国際化 例えば
APIドキュメントを支える技術 - Qiita
最近のウェブ開発では各機能ごとをAPIでつなぎ込む時代になっています。 そのため、各チームが開発をしていく上で、 他のチームにAPIの仕様を伝える方法をきちんとまとめておく必要が出てきています。 そんな中でAPIドキュメントにどのような役割が求められていて どのような選択肢があるか、一旦自分の把握している知識をまとめています。 (ここで書いているAPIは、httpでアクセスしたら、JSON形式でレスポンスを返すウェブサービスのAPIを指しています) APIドキュメントを用意する上で、すぐにぶつかる壁 APIドキュメントを用意する場合に、何も考えずにExcelやwikiにまとめると、早い段階で メンテナンスのコスト の問題にぶつかります。 『APIドキュメントを書く時間がない』 『本当にドキュメント通りの結果が返ってくるか、試してみないとわからない』 『実際に返ってくるAPIとレスポンスが違
Foursquare(Swarm) APIの使い方まとめ (サンプルコード付き)
アプリケーションの作成「新しいアプリをつくる」をクリックするアプリケーションの一覧画面に移動します。まだ、アプリケーションを1つも作成していない場合、ここには何も表示されません。新しくアプリケーションを作成するので、画面右上にある「新しいアプリをつくる」のボタンをクリックして下さい。 アプリケーションの情報を登録するアプリケーション情報の登録フォームに移動します。図を参考に、アプリケーションの情報を入力し、「変更を保存する」のボタンをクリックして下さい。後でいくらでも編集可能です。お試しの段階では、入力事項は最小限で大丈夫でしょう。1つだけ、「Redirect URI」の項目を意識しておいて下さい。ここには、後ほど、ユーザー認証作業に利用するプログラムのURLアドレスを入力する必要があります。 KEYとSECRETを確認する入力した情報に問題がなければ、アプリケーションの作成作業が完了し、
【保存版】TwitterAPI1.1 REST API 全項目解説 | Digital experience University
iOSアプリ開発担当の菅原です。 TwitterAPI1.0は2013年6月12日に廃止を予定されており、Twitterを利用する全てのサービスを対象に最新のバージョン1.1への移行が必要となっております。 ※ 廃止日は何度か変更されており、直近ですと2013年5月7日に2013年5月8日廃止が2013年6月12日に変更されました。 Twitter APIの概要やAPI1.1から新設されたツイートの表示方法を定めたディスプレイガイドラインにつきましてはTwitter API1.1 画像で見る新ディスプレイガイドラインまとめをご覧下さい。 今回はTwitter API1.1のREST APIの変更点についてお話します。 目次 REST API とは 重要な変更点 REST API 全解説 TimeLines Tweets Search Streaming Direct Messages
nginxとGoでつくるメルカリのプッシュ通知システム | メルカリエンジニアリング
原稿の締め切りを越えた先にあるもの、それは校正です。「俺達の戦いはこれからだ！」的な展開に胸が熱く・・・いえ、ちょっと胃のあたりがチクチクする@cubicdaiyaです。 今回はメルカリのプッシュ通知システムとその変遷について紹介します。 メルカリとプッシュ通知 メルカリではアプリ内でのさまざまなイベントの発生時に対象ユーザに対してプッシュ通知を行うようになっています。アプリ内で発生するイベントというのは例えば、 商品の購入 購入した商品の発送 商品に対するいいね！、コメント といったものです。通常アプリ内でイベントが発生した際はAPIサーバにHTTPSリクエストを発行し、MySQLデータベースへの参照・更新が行われた後ユーザにレスポンスを返します。そして必要であればプッシュ通知を行います。 メルカリのプッシュ通知システムの課題と変遷 メルカリのプッシュ通知システムはこの1年間で2度刷新さ
radikoをキーワードで予約する - ザリガニが見ていた...。
timerコマンドを使ってradikoやらじる★らじるを自由に録音できるようになったのだけど、予約するためには時間を指定しなければならない。時間を指定するということは、予約するためには必須の要因なのかもしれないけど、その方法で予約できるのは、自分が過去に視聴したり、番組表を見て興味を持った内容に限られてしまう...。 このインターネット時代、番組表はWebで配信されている。そして当然のようにradikoの番組表も簡単にダウンロードすることができる。ならば、ダウンロードした番組表から興味のあるキーワード検索して、未知の番組を発見できると嬉しくなりそう。やってみた。 radiko API 参考ページ：radikomemo - foltia - Trac radikoの情報は、以下のようにURLを指定することで取得できるのであった。 放送局別の番組表 J-WAVEの今日の番組 http://ra
Heroku+RailsでiOSに簡単プッシュ #ハツカソン – morizotter blog
以前から試してみたかったRailsからのPushを実行してみました。RailsにAPIを書いてHerokuにおいておいて、iOSからAPI叩くと、指定した宛先にPushが送れるというシンプルなものです。Rails学習の一環としてやってみました。 利用したもの Ruby: 2.1.1 Rails: 4.1.4 grape: 0.7.0 Houston: 2.1.0 Heroku iOS側はObjective-C。Swiftには脳内変換で対応して下さい。 参考にしたページ intridea/grape nomad/houston [iOS] NSURLSessionでマルチパートデータを送信する : 雑食プログラミング備忘録 Herokuにデプロイ – Morizotter Blog grapeとactive_adminで楽々API完成？ – Morizotter Blog Rails側で書い
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
Redirecter
Rest ful api設計入門
how-to-find-restful-api
httpbin.org