オリジナルリンク：
リフレクションAPI設計のベストプラクティス
仕上げと思考
序文
特に優れていると言って、システムはいくつかの特別なフラッシュ場所があります成功しませんが、設計努力のこまごまとが蓄積があります。
スコープ
問題はその範囲指示を明確にする必要があり話し合います。
APIの設計ガイドライン
まず、基本的な原則、我々は将来の進化の過程の中で最も問題を回避するために設計されたAPIを作ることができれば、これらの原則を遵守している基本的な原理をまとめました。
- 明確なメンタルモデルを提供
- シンプルで簡単です。
- より多くの時間を許可します
ベストプラクティス
POSIXファイルAPI
- ドキュメントまあ書かれた詳細なドキュメント
- 抽象化の適切なレベルを選択し、抽象化の適切なレベルを選択します。
- リソース名と識別の命名と識別
- 概念的に意味のある操作は、このオブジェクトのために？このリソースに妥当であるかの操作コンセプトは何ですか？
- 実現可能なアップデートは、冪等を維持しようとするたびに、更新操作の場合は、冪等を好みます
- 互換性互換性
- バッチの突然変異のバッチ更新
- フルにリスクを認識して全体の更新モードを交換するリスクに対してガードを交換
- 独自のエラー・コードまたはエラー・メカニズムを作成しないでください、独自のエラーコードを作成しようと、エラーメカニズムを返しません
上記に加えて、この記事の主要な構造である
に2つの参照リンクを提供する
GoogleクラウドAPIガイド
彼らは学ぶことのために最後に、関連する記事はInfoQを添付して
、私を、GraphQLは、RESTfulなAPIのRPC APIの反射：APIの誰もがデザイナーであります