実践：はじめてのWebAPI設計 - Qiita
はじめに この記事はAPIの基本的な実装方法を丁寧に解説します。基礎を学びたい方、今更聞けないような知識の振り返りを求める方の役に立つことを願っています。もう十分理解できている！という方は、目次から実装にとんでみてください。 具体的にはHTTPと呼ばれる通信方法を利用した、シンプルな本の貸し出しシステムの土台を考えます。要件の各ステップで、設計の基本原則やベストプラクティスについても触れながら、より実践的な知見を共有できればいいなと思います。 基本用語 Webに関する基礎知識の解説記事はQiitaに豊富にあったので、要点を抑えつつリンクをまとめました。 WebAPI WebAPIは、ウェブ上での情報のやり取りを行うためのインターフェースです。HTTPなどの通信プロトコルを介してデータを送受信することで、異なるシステムやアプリケーション間での情報共有を可能にします。 代表的な例としてスマホア
リソース指向の設計 | Cloud API Design Guide | Google Cloud
この設計ガイドは、デベロッパーが、シンプルで整合性があり、使いやすいネットワーク API を設計するために役立ちます。また、ソケットベースの RPC API と HTTP ベースの REST API の設計を統合する場合にも役立ちます。 RPC API は、多くの場合、インターフェースとメソッドの観点から設計されています。これらが追加されるにつれ、デベロッパーが各メソッドを個別に学習する必要が生じるため、負荷が大きく混乱しやすい API サーフェスになる可能性があります。これによって、膨大な時間がかかり、エラーが発生しやすくなることは明白です。 REST のアーキテクチャ スタイルは、主に HTTP/1.1 で正常に動作するように設計されていますが、この問題への対処にも役立ちます。そのコア原則は、少数のメソッドを使用して操作可能な名前付きリソースを定義することです。リソースとメソッドはそれ
GraphQLはWeb APIの次のフロンティアか？ | POSTD
RESTの規約。URLはリソースであり、CRUDはHTTP動詞にマップされる。 RESTの規約に1つ問題があるとすれば、規約が十分でないということでしょう。上記で”通常”、”多くの場合”、”時に”という表現を使ったのは、これらのやり方は仕様で推奨されているものの守られるとは限らないためです。実世界では、大抵のAPIはRESTishがせいぜいです。例えばStripeでは、リソース更新に PUT ではなく PATCH を使うべきですが、歴史的理由でそうはなっておらず、おそらく現時点では変更に値しないでしょう。いずれにしても開発者はドキュメントを読む必要があり、その時、 POST メソッドのユビキタスな使い方があることに気づくのです。 RESTには他の問題もあります。必要なものだけでなく全てが返ってくるため、リソースのペイロードが非常に大きくなることがあるのです。そして多くの場合、クライアントが
APIなどにfile_get_contents()を使うのはオススメしない理由と代替案
file_get_contents() はファイルパスを指定してデータを取得するだけではなく URLを指定すればそのURLの情報を手軽にとれる関数ですが 対API等に使うと色々とハマるポイントが多いので、それを簡単に解説したものです。 ※このページ向け に書いていたものですが、コード量が多いので分割しました。 問題点 file_get_contents() は ヘッダ情報の保持ルールやタイムアウト処理に癖があるため 返却されるステータスコードや、タイムアウト時に再リクエストなどを行うような 対APIの処理では、それらを知らないと想定していない事態に陥る。 コード例と解説 以下の要件でfunctionを書くとします。 jsonが返ってくるAPIにアクセスして、jsonをarray化する。 タイムアウトは3秒とし、そうなった場合は空の配列が返ってくる。 ステータスコードが200以外で返ってきた
HTTPステータスコードを適切に選ぶためのフローチャート : 難しく考えるのをやめよう | POSTD
HTTPステータスコードを返すというのはとても単純なことです。ページがレンダリングできた？よし、それなら 200 を返しましょう。ページが存在しない？それなら 404 です。他のページにユーザをリダイレクトしたい？ 302 、あるいは 301 かもしれません。 I like to imagine that HTTP status codes are like CB 10 codes. "Breaker breaker, this is White Chocolate Thunder. We've got a 200 OK here." — Aaron Patterson (@tenderlove) 2015, 10月 7 訳：HTTPのステータスコードのことは、市民ラジオの10コードみたいなものだと考えるのが好きです。「ブレーカー、ブレーカー、こちらホワイト・チョコレート・サンダー。200
Cerevo、Webサービスと連携する小型の鍵スイッチ「Hackey」発売 | Cerevoからのお知らせ
2015年10月28日 Cerevo、Webサービスと連携する小型の鍵スイッチ「Hackey」発売 ～ヤフーの「myThings」にも対応。API利用で独自サービス連携も可能～ ネット接続型家電の企画・開発を手掛ける株式会社Cerevoは、Webサービスと連携するカスタマイズ可能な物理鍵スイッチ「Hackey（読み：ハッキー）」を10月28日に発売します。Cerevoの直販サイト「Cerevo official store」では9,980円（税別）で発売するほか、海外向けにindiegogoでの展開も同日より開始いたします。 Hackey http://hackey.cerevo.com/ja/ Hackeyは、無線LANを内蔵した手のひらサイズの鍵スイッチです。本体のみでインターネットに接続でき、鍵スイッチをオンにすることで対応Webサービスを操作できるため、ハードウェアエンジニアだけで
FluctとAPI Gateway+LambdaでWebアプリをつくる - Qiita
Fluctというツールを使いながら、Amazon API GatewayとAWS Lambdaを組み合わせてWebアプリをつくる方法について説明します。JavaScriptで実装でき、自動的にそこそこスケールし、Amazon EC2などで自前のWebサーバを常時稼働させておく必要なく、基本的にはリクエスト回数と転送量に応じてのみ課金されるようなWebアプリの環境を手に入れることが目的です。 Amazon API Gatewayとは Amazon API GatewayはWeb APIを簡単に作成・公開・管理するためのサービスです。2015年7月9日に新しく公開されました。Qiitaにも既にいくつかの記事が投稿されています。それ自身はプロキシとして振る舞い、バックエンドのサービスが提供するデータや機能にアクセスするための入口として振る舞います。 バックエンドのサービスには、AWS Lambd
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を設計してみるとどんなインターフェイスがいいのか、どんな形式がいいのかといった疑問が次々と出てきます。
sowawa - Hack FlashAir
今日は、少し前からいろいろ遊んでいるFlashAirについて書きます。 FlashAir 簡単にFlashAirを説明すると。 FlashAirは、外見や規格は普通のSDカードに SDカードの通常の機能に加えてWifi機能を搭載しており、 この機能を使うことでネットワーク経由で様々な情報の入出力を行えます。 使い方によってはいろいろなことに使える、まさに十徳ナイフのSDカード版です。 FlashAir™ そして、なんと！ 日本の電機メーカの製品でありながらAPIとAPIドキュメントが提供されています! （東芝++） とてもいじりがいのありそうな製品ですね。 FlashAir Developers - ホーム FlashAirのAPIについて FlashAirのAPIは、SDカード上で小さいWebサーバが動いており、基本的には単純なHTTPによって提供されます。 詳しくは FlashAir
UnityでGoogleストリートビューを使ったハコスコ対応アプリを作る - Qiita
UnityでGoogleストリートビューを使ったハコスコ対応アプリを作る Google Street View Image APIを使うとHTTPリクエストでストリートビューの画像を取得することができます。UnityのWWWクラスを使ってストリートビューの画像を取得し、全周囲画像を作ってハコスコで体験してみましょう。Unity無料版で動作させることができます。 全周囲画像の作成 カメラを中心に、上下左右前後に配置したPlaneにストリートビュー画像を貼付けて全周囲画像を作ります。はじめにカメラを原点に置きます。カメラを中心に上下左右前後にPlaneを置きます。向きや裏表面は後で調整しましょう。また、RenderSettingsのAmbient Lightは白にしておきます。 次に、ストリートビュー画像を取得するスクリプトを書きます。プログラム実行時に、指定された緯度経度、heading、p
REST における PUT メソッドと POST メソッドの違い - 星一の日記
最近 REST に関する本を読んでいます。統一された少ないルールで、さまざまな Web アプリケーションを表現できるというのは、妄想が膨らんでワクワクしますね。学んだことをメモがてらに書きます。 RESTful Webサービス 作者: Leonard Richardson,Sam Ruby,山本陽平,株式会社クイープ出版社/メーカー: オライリー・ジャパン発売日: 2007/12/21メディア: 単行本購入: 25人 クリック: 842回この商品を含むブログ (168件) を見る PUT も POST も似た役割をもつメソッドです。両方ともリソースの新規作成または更新を行います。この二つのメソッドは何が異なり、どのように使い分けるべきなのでしょうか。 リソースの新規作成 まずリソースの新規作成について。 PUT は URI が指し示すリソースを直接作成することを、サーバーに要求します。たと
Web API 設計のベストプラクティス集 "Web API Design - Crafting Interfaces that Developers Love" - フリーフォーム フリークアウト
移転しました http://please-sleep.cou929.nu/20130121.html
1
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く
HTTP APIの詳細なエラー情報をレスポンスに持たせるための仕様
RESTfulとは