November 2014
Intermediate to advanced
224 pages
3h 22m
Japanese
Content preview from Web API: The Good Parts
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
付録AWeb APIを公開する際にできること
Web APIを公開するにあたって、Web APIそのものを構築する以外に、そのAPIを利用する開発者がより楽に利用できるようにするために、やっておいたほうがよいことがいくつかあります。ここではそういった事柄を紹介します。
A.1 APIドキュメントの提供
APIを構築する際に必ず考えなければならないのは、そのAPIの使い方を示したドキュメントを用意することです。ドキュメントがなくては、開発者はAPIへのアクセスの仕方がわかりません。もし同じチームでサーバとクライアントを書いており、クライアントのエンジニアがサーバのコードにアクセスできるのであれば、コードを読んで仕様を理解するという方法も考えられますが、第三者に公開するAPIではそういうわけにはいきません。したがってきちんとしたドキュメントを提供することは、公開したAPIを多くの人に利用してもらえるようになる第一歩といえます。
ドキュメントを公開するにあたって注意すべきことは、APIのドキュメントをきちんと常に最新にしておくことです。これはWeb APIに限った話ではありませんが、開発の際にドキュメントの更新が後回しになった結果、実際のAPIとドキュメントの内容に差異が生じるといったことがないよう注意する必要があります。
API Blueprint（http://apiblueprint.org/）というWeb APIのドキュメントを書くための記法も存在しています。これはMarkdown記法を使ってAPIの仕様を記述するものです。
# Gist Fox API Root [/] Gist Fox API entry point. This resource does not have ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.