2010年10月17日日曜日

WebAPIを設計するときの注意点

Web2.0(死語?)でマッシュアップな現代において、Webアプリを構築するときにはAPIも考えておく必要がある。最近APIの提供元が犯す10の間違い(英文)APIの提供元が犯す、別の10の間違い(英文)という記事を見て、よくまとまっているなと感心した。翻訳するのは面倒なので、とりあえず箇条書きに抜き出してみた。だれか翻訳してくれないかな~。

10 Common Mistakes Made by API Providers - ReadWriteCloud

  1. Assuming Everything Will Always Work
  2. Poor Community Management
  3. Not Anticipating How API Business Processes Will Scale
  4. Putting the API Under Website Domain
  5. Lack of Real-World Testing
  6. Not Anticipating Bad Behavior
  7. No Black Box Tests
  8. Not Recognizing the API as a Core Line of Business.
  9. Not Having Management on Board with the API
  10. Tunneling Errors

Another 10 Mistakes Made by API Providers - ReadWriteCloud

  1. Naming Convention
  2. URL Consistencies
  3. Authentication
  4. Simplicity
  5. Object normalization
  6. Documentation
  7. Be Forward and Backward Thoughtful
  8. Error Messages Are Important
  9. Making it Parsing Friendly
  10. Allow for Subsets

0 件のコメント:

コメントを投稿