Web APIを正しく呼び出す方法

Question

ASP .NET Webサイトでは、.NETクライアントからWeb APIを呼び出す方法についてan exampleがあります。

彼らは、新しい製品を作成する電話をかけるには、このメソッドを持っている：

static async Task<Uri> CreateProductAsync(Product product) 
{ 
    HttpResponseMessage response = await client.PostAsJsonAsync("api/products", product); 
    response.EnsureSuccessStatusCode(); 

    // Return the URI of the created resource. 
    return response.Headers.Location; 
} 

これは、任意の言語やフレームワークのいずれかのAPIへの呼び出しを行うための通常の方法のようですが、私はたくさんのを見ますこの行の問題：

"path"パラメータが文字列の場合、コンパイル時に発生する可能性のあるエラーを検出する方法はありません。また、APIが変更され、多くの呼び出しがあった場合は、すぐに呼び出しを再構築する方法はありません。

この種の問題を回避するための呼び出しを構築する方法はありますか？たとえば、私たちはWebサービスと同様に、

Answer 1

Nkosiが言及したように、それはどのように設計されているかです。しかし、あなたはあなたのWEBAPIが変更された場合、あなたは簡単にパスを変更することができますこの方法をAPI URIの持つクラスを作成し、それらの代わりに、リテラル

public class ApiUris 
{ 
    public const string Products = "api/products"; 
    public const string Services = "api/services"; 
    public const string Orders = "api/orders"; 
    /* ... */ 
} 

を使用することができます。

Answer 2

ちょうどあなたが

System.Web.Routing.RouteTable.Routes.ToList(); 

を使用して、ルートの一覧を取得することができアダムの解に延びる次にパスを得ることがRouteBase抽象クラスの具体的な実装に依存します。

Answer 3

WebサービスとWCFサービスでさえ、サーバーがURLのタイプやパラメータの構造を変更すると、ビルドに失敗します。あなたは、あなたがそのサービスに電話をかけて壊れたときにだけ、その変化を知るようになります。

Web APIを呼び出す場合は、APIを呼び出すまで、URLまたはパラメータメーターが間違っていることがわかりません。

同時に、Web APIは頻繁に変更されるようには構築されていません。彼らが信頼できない場合、誰もそれらを使用しません。したがって、APIを使用している場合は、URLを変更したり、特定の入力パラメータのサポートを一夜停止したりして、あなたのようなコンシューマアプリケーションを中断させないようにすることができます。彼らは確かに彼らの顧客によって訴えられることを望んでいません。

すべてのAPIは、徐々に変更され、顧客によく知らされているため、新しいバージョンのAPIをサポートするように実装を変更する時間があります。 あなたはあなたが使用しているサービスに頼り、それに関連する値（URLなど）を設定ファイルに入れるだけで十分です。あるいは、API Urlをデータベースに入れることで、変更時にデータベースのエントリを更新するだけで、変更がすぐに有効になるようにすることができます。