iOS Framework for ODPTData

お知らせ

• 本文の公開を始めました。一部工事中です(2019-9-8)

概要

iOS Framework for ODPTData は、 ODPT APIへのアクセスを必要とするiOSアプリのために 作成されたフレームワークです。

ODPT(Open Data for Public Transportation) APIとは、 東京周辺の公共交通機関の情報を得られるRESTful Web APIで、広く公開されています。

一方、このAPIにアクセスするアプリを開発するには、ただアクセスして情報を得るだけでは十分ではありません。 優れたUIを実現する有用なアプリとするためには、そのほかにも様々な機能を装備する必要があります。

このフレームワークはODPT APIに直接アクセスするiOSアプリのために開発されました。
以下の機能があります。

• アクセスレート制限にかからないように、連続的なHTTPリクエスト発行
• 取得したデータをキャッシュ
• 同時かつ、重複したアクセスがある時の効率化
• App側が利用しやすいよう、オリジナルODPTデータ内容を一部調整
• 拡張可能なアーキテクチャ

上記の機能により、アプリ起動時に発生する短期間の大量アクセスや、 ユーザーの操作に応じた単発的なアクセスに、破綻なく効率的に、APIにアクセスします。

このフレームワークは、iOSアプリ トーキョーラインズ Ver.2.0.4 以降に適用されています。

現時点(2020年3月)で、3種類のODPT API,それに類似したAPIが公開されています。

• 東京メトロ オープンデータ API
• 公共交通オープンデータ API
• 第4回 東京公共交通オープンデータチャレンジ用API

それぞれ、公開されている路線・駅の情報や、許諾されている使用対象などが異なります。 3番目のAPIが、公開されている情報の内容が最も豊富で、トーキョーラインズもこのAPIを使用しています。 このフレームワークはこのAPIを前提に開発されています。

このフレームワークの開発者は、各ODPT APIの管理者とは関係がありません。 このフレームワークを有効に活用するには、別にAPI管理者が定めるAPI使用許諾に同意し、遵守しなければなりません。

技術情報

• 使い方
• 独自仕様について
• リファレンス

ライセンス

このソフトウェアは、MITライセンスの下で公開されています。

本ソフトウェアを使ってODPT APIにアクセスするには、このソフトウェアライセンスとは別に、API使用許諾に合意し、遵守する必要があります。

あなたの作品に本ソフトウェアが含まれていても、東京公共交通オープンデータチャレンジなどのコンテストに応募することができます。 あなたの作品がコンテストで入賞したとしても、本ソフトウェアの開発者は、入賞に関わる一切の権利を主張することはありません。

作者

Takehito Ikema