付録AWeb APIを公開する際にできること

Web APIを公開するにあたって、Web APIそのものを構築する以外に、そのAPIを利用する開発者がより楽に利用できるようにするために、やっておいたほうがよいことがいくつかあります。ここではそういった事柄を紹介します。

A.1 APIドキュメントの提供

APIを構築する際に必ず考えなければならないのは、そのAPIの使い方を示したドキュメントを用意することです。ドキュメントがなくては、開発者はAPIへのアクセスの仕方がわかりません。もし同じチームでサーバとクライアントを書いており、クライアントのエンジニアがサーバのコードにアクセスできるのであれば、コードを読んで仕様を理解するという方法も考えられますが、第三者に公開するAPIではそういうわけにはいきません。したがってきちんとしたドキュメントを提供することは、公開したAPIを多くの人に利用してもらえるようになる第一歩といえます。 ...

Get Web API: The Good Parts now with the O’Reilly learning platform.

O’Reilly members experience books, live events, courses curated by job role, and more from O’Reilly and nearly 200 top publishers.