海外テック情報局

API設計に関する10のワーストプラクティス

この記事を読むのに必要な時間:およそ 0.5 分

画像

ソーシャル機能の実装など外部サービスのAPIを使ったアプリケーションが増える中,⁠使いづらい設計のAPI」は,開発者にとっては頭の痛い問題ではないでしょうか? Programable Web注1上に投稿されたAPIのワーストプラクティスに関する記事が国内外の開発者の目に止まり話題になっています。この記事によると悪いAPIに見られるプラクティスは次のようなものだそうです。

  1. 貧弱なエラーハンドリング
  2. HTTPのルールを無視したREST API
  3. 裏に潜んだ生のデータモデルの露出
  4. セキュリティの複雑さ
  5. ドキュメント化されていない予期せぬリリース
  6. 貧弱なデベロッパエクスペリエンス
  7. MVCModel-View-Controllerフレームワークが良いAPIにしてくれるという思い込み
  8. 開発すれば使ってもらえるとみなすこと
  9. 不十分なサポート
  10. 貧弱なドキュメント

自分自身のサービスがAPIを公開する場合などは大いに参考にしておきたい項目ですね。

注1)
APIなどのオンラインディレクトリオンラインディレクトリサービスです。

URLhttp://blog.programmableweb.com/2012/08/03/top-10-api-worst-practices/

著者プロフィール

安藤祐介(あんどうゆうすけ)

下北沢OSS カフェの常連。今年はオープンソース博物館を企画したいです。

Twitter:yando

小倉純也(おぐらじゅんや)

QNYP, LLC. のプログラマ。今年はヨーロッパに行ってみたいですね。

Twitter:junya

溝畑考史(みぞはたたかし)

怒濤の新年ラッシュを過ぎてようやくまともなサンフランシスコ生活。

Twitter:beatak

コメント

コメントの記入