Secrets of a Great API

MuleSoftのホワイトペーパーですが、APIビジネス成功の秘密は下記の4点があります。

  • Design for a great user experience
  • Optimize for a particular use case
  • Provide easy access
  • Build a community

メモ:

APX (API User Experience)
APIの目的と機能がわかりやすく、API利用者が設計時にバックエンドの仕組みを意識せずに、手戻りがないように設計しないといけない
MuleSoftのAPI DesignerやSwaggerなどのスキーマ設計ツールを活用し、データ構造が分かりやすいように

APIはユースケース指向である
あまり汎用なAPIがあっても仕方ない。ビジネスプロセスに特化し、コンテキストを重視
たとえば、モバイルアプリケーション用のAPIはPC Webアプリケーション用のものを区別すべき(通信回数やデータサイズの配慮など)
データ粒度の高いAPIと低いAPIをうまく提供すること

開発者向けのポータルサイトを用意、必要なドキュメントとサンプルが簡単に見つけるように工夫
簡単に試せるような試用APIを提供

コミュニティーが重要