現在ではREST APIはとても一般的な話題です。ほとんどすべてのWebアプリケーションの一部分となっています。シンプルで一貫性があり実際的なインターフェースは必須です。これは皆さんのAPIを他の人が使うことをとても容易にします。皆さんにとってはRESTの実践が日常的に感じられるかもしれませんが、RESTをあまり尊重しない人々もよく見かけます。これがRESTについて投稿するきっかけでした。 この記事にはRESTfulなAPIを設計する時に考慮すべきベストプラクティスがあります。 注意 : ここでのベストプラクティスは、私が過去の経験に基づいて良いと考える事例です。もし違う考えをお持ちであれば、お気軽にメールをくだされば意見交換できると思います。 APIのバージョンを示す APIのバージョンは必須であるべきです。これがあると時間が経ってAPIが変わっても影響を受けません。その方法の1つはUR
TL;DR JSON Schemaを使ってこういうことが実現可能になった。 ダミーAPIサーバの提供 ドキュメントの自動生成 APIクライアントの動的定義 APIサーバのバリデータの動的定義 APIサーバのレスポンスの自動テスト JSON Schemaとは JSON SchemaというのはあるJSONのデータ構造を記述するための方法および書式の仕様で、 JSON SchemaもJSONで記述される。 これを利用すれば、リソースベースの(=RESTfulライクな)APIの仕様が簡便に記述できる。 例えば、我々のAPIはレシピとユーザというリソースを扱っていて、 それぞれCRUDのAPIを備えており、レシピはidとtitleとdescriptionという属性を持つ、 という旨をJSON Schemaで表現できる。 なんで最近ちょっと流行ってんの Mobile First、 Service Or
気象庁防災情報 XML 検索 API JSON 形式で応答を返す Web API です。以下の URL にパラメータを付加して GET してください。 指定したパラメータと値によってデータベース内の気象庁防災情報 XML を検索し、一致するものへのリンクが返されます。 http://api.aitc.jp:80/jmardb/search 使用可能なパラメータは以下のとおりです。パラメータの名前はすべて小文字です。 実際の各パラメータの値がどのようなものかは、トップページで検索した結果の一覧を見ると把握できると思います。 また、文字列の検索は部分一致でなく完全一致であることに注意してください。 status
ヤフー株式会社は、2023年10月1日にLINEヤフー株式会社になりました。LINEヤフー株式会社の新しいブログはこちらです。LINEヤフー Tech Blog Yahoo!デベロッパーネットワークの中野(@Hiraku)と申します。 「WebAPIの魅力を存分に宣伝せよ」という使命を受けまして、これから何度かTechblogを書くことになります。以後、お見知りおきを。 さて、Yahoo! JAPANが公開しているWeb APIはたくさんありますが、JSONPに対応しているものがいくつかあります。ショッピング、オークション、YOLP、震災関連情報などです。 JSONPについて詳しくは過去記事を見てください。 他の形式に比べると、サーバーを準備しなくてもブラウザーだけで動かすことができ、古いブラウザーでも動くという、JSONPにしかないメリットがあります。夢のような形式！なのです。 …そのは
にどめまして！前回の住所正規化 APIが好評なようで花粉症が吹き飛んでいた Yappo です。 さて、今回は表題の通り鉄道情報 APIをリリースしたのお知らせです。 鉄道情報 API ってなに? 日本国内の鉄道路線や鉄道駅を検索する事が出来る API です。 例えば、路線一覧や山手線の駅一覧を JSON 形式で簡単に取得出来ます。 基本的にはデータソースとして駅データ様のデータを利用しているため、基本的には駅データの仕様に準拠していますが、ロケタッチ独自の情報を付与したデータを返しています。 使い方 使い方は簡単で、前回の住所正規化 API のように単純に GET リクエストを飛ばすだけで良いです。 例えば山手線の全駅リストを Perl で書きたい場合には以下のように書きます。 use strict; use warnings; use 5.016; use JSON; use LWP::
リリース、障害情報などのサービスのお知らせ
最新の人気エントリーの配信
処理を実行中です
j次のブックマーク
k前のブックマーク
lあとで読む
eコメント一覧を開く
oページを開く