パブリックAPIを作成するためのベストプラクティスを示すリサーチデータはどこにありますか？

Question

社内のプライベートAPIを単に公開することは、パブリックAPI候補を作成し、内部で使用し、満足して公開するベストプラクティスに比べて悪い考えであるという管理（製品管理など）を説得する必要があります。誰かが私が議論をするのに役立つ研究論文のような事実を見つけるのを助けることができますか？

Answer 1

APIへのパブリックインターフェイスは非常に主観的であり、特に問題のドメインに結びついているため、私は特定の研究について知らない。

このPDFファイルの最初の数ページには、ビジネスパーソンのためのAPIのOK概要です：http://aarontgrogg.com/wp-content/uploads/2009/09/How-to-Build-API-and-why-it-matters.pdf

あなたのビジネスパートナーは、「私はあなたを考えると考える必要があり、このブログの記事のセクションヘッダーのハイライトのキーポイント すでに気づいている。 Webサービス対http://gaejexperiments.wordpress.com/2010/07/01/public-api-design-factors/

• APIフォーマット休憩
• 回答フォーマットのXML
• サービス契約の説明
• 認証メカニズムのため、JSON
を：彼らはパブリックAPIに関連するように私は、これらの特定の被験者の周りのベストプラクティスを探しますAPIのコンシューマ
• サービスのバージョン管理（全員を吹き飛ばすことなく新しいバージョンのAPIを公開できます）
• レートリミット（明らかに、任意のnuパブリックAPIのためのDOS攻撃を防ぐ事のmber、そしてちょうど管理システム負荷）
• ドキュメント
• ヘルパーライブラリ
• サイト
• それはAPIの種類...サポートチーム
に応じて、

これは内部プロセスにも対応していません。あなたの内部システムはパブリックAPIよりも速く進化しなければならないのでしょうか？ほとんどの場合、あなたの会社はビジネスモデルと戦略で機敏であることを望んでいるので、答えは「はい」だと思います。第三者が内部システムを消費すると、更新を行う時期が来たときに、誰がより重要なのかを決定することが強制されます。あなたの会社は内部サービスをバージョンアップする必要があり、第三者の消費者がタイムリーにアップグレードされることを望むか、または第三者のすべての消費者のための統合を破ることを望むでしょう。

1日の終わりに、それは価値がないかもしれません。 APIの使用を止める前に、あなたのAPIを何度も使用して人をぶつけ合うことができます。それを誰も使用しなければ何が良いのでしょうか。

私は以前、ビジネスがAPIを急速に押し上げることを望んでいましたが、その周りのガバナンスはありませんでした。その結果、私たちのAPIと統合していた人たちをサポートし、それらのためのコードサンプルを書く時間を費やしていました。