5分で絶対に分かるAPI設計の考え方とポイント（1/6 ページ）

API設計を学ぶべき背景と前提知識、外部APIと内部API、エンドポイント、レスポンスデータの設計やHTTPリクエストを送る際のポイントについて解説する。おまけでAPIドキュメント作成ツール4選も。

[鈴木雄登，CyberZ]

【0分】API設計を学ぶべき背景

APIの公開が増えている

　最近、自社で保有するデータや、システム、アプリケーション、Webサービスの機能を「API（Application Programming Interface）」として公開する企業が、増えてきています。これに伴い、「API経済圏（APIエコノミー）」という新たなビジネスモデルが確立されつつあります（参考：5分で絶対に分かるAPIマネジメント、API経済圏）。

　「ProgrammableWeb」というAPIに関するニュースサイトや、さまざまな企業が提供するAPIのリンクがまとまったサイトもあり、APIの普及はものすごいスピードで進んでいることがうかがい知れます。

　例えば、TwitterはAPIを公開しており、一般的なTwitterの投稿と閲覧という使い方だけではなく、Twitterを利用した拡張ツールが作られるなど、APIの公開がTwitterサービスの拡張自体に大きく貢献しました。

　また、これまでAPIと言えば、Webサービスの情報を取得・編集するということが主流でしたが、最近ではIoT（Internet of Things）の普及に伴い、温度や湿度、重力、人／モノの動きなど、現実世界の情報を取得するAPIも出てきています。

　例えば、パ・リーグのプレーシーン映像を検索できる「パ・リーグ イノベーション API」や、自動車の運行情報をリアルタイムに取得できる「トヨタITC クルマ情報Web API」などが話題になっています。

　このように、さまざまな企業がAPIを活用してビジネスを拡大する動きは増えつつあり、IT技術者にはAPIを設計する機会が増えていくことでしょう。API設計をする上では、まず「ユーザーが使いやすいAPI」ということに留意して設計することで、広く使われ、プロダクト自体の発展にも寄与することと思います。ぜひ、これを機に、自社データを活用するようなAPIを設計して公開してみてください。

　では、次ページからAPI設計の考え方とポイントを5分（1ページ約1000文字）で解説していきます。

• 【1分】API設計をする際の前提知識
• 【2分】APIの設計に入る前に考えておくべきこと
• 【3分】エンドポイントの設計
• 【4分】HTTPリクエストを送る際のポイント
• 【5分】レスポンスデータの設計
• 【おまけ】APIドキュメント作成ツール4選