Web APIでHypermediaリンクを生成する

Question

他の人がWeb APIのハイパーメディアリンクを生成する問題をどのように扱っているのか不思議です。具体的には、私はASP.NET Web APIを使用しており、操作でハイパーメディア関連の型を返すか、リソース自体を返すことと、後でハイパーメディアの問題がパイプラインで発生することとの間で悩まされています。

public Resource<Order> GetOrder(int id) { 
    return new Resource<Order>() { 
     Content = new Order(), 
     Links = new LinkCollection<Order>() { new AddOrderLink(), new UpdateOrderLink()} 
    } 

以上

public Order GetOrder(int id) { return new Order(); } 

のようなもの。そしてHttpOperationHandlerまたはカスタムフォーマッタか何か内部のハイパーメディアリンクを追加：ある 、人々のようなことを行う傾向があるのですか？

アプローチが＃2のような場合は、どのようなリンクを生成するのかをどのように知っていますか？すべてのOrderオブジェクトに対して生成される標準的なリンクがいくつかありますか？ OrdersControllerのさまざまな操作を装飾する属性ですか？

Answer 1

私はオプション2（後でハイパーメディアリンクをパイプラインに追加する）とblogged about doing this yesterdayを優先します。

解決策は、メッセージハンドラを使用してクライアントに返される前に、ハイパーメディアリンクを使用して自分のリソースを「充実させる」ことでした。

Answer 2

あなたは、私はそれはそれを行うにはいいと簡単にできるようにseens、あなたがnugetパッケージを経由して、それを得ることができるように私の次のプロジェクトでそれを使用することを計画していますgithub

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

Answer 3

ASP.NET MVC はWeb APIのtext/html-constrainedバージョンとして表示されるため、この問題を処理するためのASP.NET MVCのアプローチを検討することは有益です（マニュアルコンテンツのネゴシエーションにもかかわらず）、明らかにWeb APIの設計に多大な影響を与えたためです。

基本的には、カスタムフォーマッタを使用して、ルート属性またはアクション属性に基づいて表現を変更できます。これは、ASP.NET MVCがモデルからビューを分離する方法によって通知されます。 ASP.NET MVCプロジェクトでは、単一のモデルをさまざまなビューテンプレートでレンダリングできます。これらのビューテンプレートのそれぞれは、遷移リンク（アンカー、フォーム、リンク要素）を本質的にモデルの特定の表現に「ハードコードする」。ビューテンプレートの選択は、慣例（コントローラーおよびアクション名）によって主に行われますが、アクション内でハードコードすることもできます。

ASP.NET MVCでのビューエンジンとビュー検出規則は、カスタムWeb APIフォーマッタと見なすことができます。これは、サポートされているメディアタイプごとに、カスタムフォーマッタが経路の詳細（およびオプションで呼び出されたアクションメソッドに適用される属性）を使用してリソース状態を定義するように一般化することができます。 （この規約の下では、リソースの状態を反映するアクション名を選択することでメリットがあります。）フォーマッタはリソースの状態を認識した後、州固有の書式設定コードに委任することができます。このコードでは、州固有のリンクが定義されています。

この州固有のフォーマットコードは、Razorビューが部分ビューの合成をサポートするのと同じように、他のサブフォーマッタに委譲することもできます。

Answer 4

私は私の解決策here

それはクラスを使用し、プロパティがエンティティにリソースリンクオブジェクトを移入するApiController伸長法と組み合わせて属性を追加しました。また、任意のコレクションプロパティのリンクを設定することもできます。完成した記事ではありませんが、直感的であり、良いスタートを切ることができます。