タグ

RESTとwebapiに関するteracy_junkのブックマーク (8)

  • WEB Apiの話 (Restful) - Qiita

    Twitter streaming api cybozudev api Restとは RESTはREpresentational State Transferの略。 RESTの原則に従って実装されているシステムのことを、RESTfulと呼ぶ。 RESTの世界では、ネットワーク上のコンテンツ(リソース)を一意なURLで表すのが基。 各リソース(URL)に対してPOST、GET、PUT、DELETEでリクエストを送信する。 上のリクエストは、CRUD(Create、Read、Update、Delete)に紐付ける。 大体、レスポンスをXMLやjsonの形式で受け取る。 Restの設計 URL設計 リソースを名詞であらわす。例: /user/10 /song/5 video/7 POST は create, GET は read, PUT は update, DELETE は delete。H

    WEB Apiの話 (Restful) - Qiita
  • REST APIの例外設計 - GeekFactory

    REST APIを設計する場合に、エラーをどのステータスコードで返却するか議論になることがあります。例えば、以下のような場合が挙げられます。 キー指定のリクエストでDBにデータがない場合(例: GET /books/1 ) 一覧のリクエストでDBにデータがない場合(例: GET /books ) 必須項目がない、型が合わないといった場合(例: GET /books/find?count=bar ) ビジネスルールに違反する場合(例: POST /purchase ) 実行時エラー(例: NullPointerException ) クライアントが適切にエラーを処理できるように、レスポンスにエラー原因を入れることが一般的です。では、ステータスコードは何がいいのでしょうか。HTTPのステータスコードはRFCで定義されているし、RESTの考え方はWebや書籍にまとまっていますが、あくまでも考え方

    REST APIの例外設計 - GeekFactory
    teracy_junk
    teracy_junk 2016/11/02
    『クライアントが適切にエラーを処理できるように、レスポンスにエラー原因を入れることが一般的です。では、ステータスコードは何がいいのでしょうか』悩ましい
  • Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita

    この記事は、微妙に以下の記事の延長線上です。わかりにくければ、こちらから読んでいただいた方がいいかもしれません。 LittleBitsを使ったIoTをつくり、家の室温変化のグラフをインターネットから見る(前編) - Qiita 「インタラクティブなWeb APIドキュメント」とはどういうものか Swaggerというツールを使います。Web APIYAMLで書いておいて、Swaggerでサーバを立てると、読むだけのドキュメントではなくて、以下のようにパラメータを指定して実際にHTTPリクエストを送ることができるWebページが生成されます。 以下が返ってきたレスポンスです。 以下は実物です。ご自由に動かしてみて下さい。 インタラクティブなWeb APIドキュメント まだちょっと分かりにくいという方のために、アノテーションからドキュメントを作れるswaggerの使い方 - gong023の日記

    Swaggerを使ってインタラクティブなWeb APIドキュメントをつくる - Qiita
  • https://qiita.com/magaya0403/items/0419d84d8df7784ac465

  • Android/iOSアプリ開発プロジェクトのRESTful APIのガイドラインを公開してみる - Qiita

    これは何? 今チームで使っているAPIガイドラインを公開してみます。 RESTful APIの設計のための資料をあさりつつ、アプリのクライアント向け(特にAndroid)やRuby (GrapeとRails)向けに調整したり決定したりした部分があり、その辺りのプラクティスが含まれています。 このガイドラインでは主にRESTful APIの一般的なプラクティスでは不足している内容について記述されています。 ※iOSはObjective-C製で、RestKitやMantleを使わずAFNetworking/NSURLSessionを使っていますが、AndroidはRetrofitを使っています。 (特にiOS用に)こうしたほうが良い!ということがあればコメントお待ちしております! 副題:(チーム名)のAPIを支える技術 関連資料 書籍など Web API: The Good Parts 書籍、

    Android/iOSアプリ開発プロジェクトのRESTful APIのガイドラインを公開してみる - Qiita
  • 今さら聞けないWebAPIの実装方式RESTとSOAPの違い - Qiita

    REST API RESTはREpresentational State Transferの略。 RESTの世界では、ネットワーク上のコンテンツ(リソース)を一意なURLで表すのが基。 各リソース(URL)に対してGET,POST,PUT,DELETEでリクエストを送信しレスポンスをXMLやjsonなどで受け取る形式(レスポンスのフォーマット形式は指定されていない)。 RESTはURLがリソースに対応づけられるためURLは名詞的になることが多い。 SOAP API SOAPはSimpleObject Access Protocolの略。 リクエストおよびレスポンスともにXMLフォーマットのデータで行う形式。 SOAPのURLは操作と対応づけられるため、URLの命名が動詞的になることが多い。 参考: http://programming-10000.hatenadiary.jp/entry

    今さら聞けないWebAPIの実装方式RESTとSOAPの違い - Qiita
  • RESTful Web API 開発をささえる Garage - クックパッド開発者ブログ

    技術部の小野(@taiki45)です。この記事では簡単なアプリケーション(ブログシステム)の実装を通して、クックパッドで作成・使用しているライブラリのGarage の紹介と Garage を使った RESTful Web API の開発をご紹介したいと思います。 Garage は RESTful Web API を開発するための、 Rails gemified plugins です。Rails プログラマは Garage を使って Rails を拡張することで素早く Web API を開発することができます。Garage は新しくアプリケーションを開発する場合にも、既存の Rails アプリケーションに組み込んで Web API を実装する場合でも使用できます。Garage はリソースのシリアライズやアクセスコントロールなど Web API の実装に必要な機能をカバーしています。 Ruby

    RESTful Web API 開発をささえる Garage - クックパッド開発者ブログ
  • 気象庁が提供する防災情報のAPI公開--RESTやSPARQLなど

    印刷する メールで送る テキスト HTML 電子書籍 PDF ダウンロード テキスト 電子書籍 PDF クリップした記事をMyページから読むことができます 先端IT活用推進コンソーシアム(AITC)は2月17日、気象庁から提供されている気象警報などの情報を利用できるAPIを開発、公開した。 公開したAPIは、HTTPを使用してプログラムからも最新のデータなどを呼び出せる「REST」、自由に抽出、集計できるとともに過去のデータを検索できる、クエリ言語の「SPARQL」、通信規格の1つでありHTTPより軽量とされている「WebSockets」の3種類となっている。 公開APIで利用できるデータは、2012年12月から気象庁が試験的にネット経由で配信している「気象庁防災情報XMLフォーマット形式電文」(防災情報)の内容。公開APIを通じて過去のデータを含め、気象庁が発表した防災情報を取得できる。

    気象庁が提供する防災情報のAPI公開--RESTやSPARQLなど
  • 1