67

API を構築する最善の方法を見つけようとしています。標準の REST 構造 (1 つをリスト、すべてをリスト、作成、更新など) で設定したレビューがあります。例に当てはまらないのは、各レビューを 1 つ以上の他のタイプ (イベント、場所、モノなど) にリンクできることです。

私の考えでは、URL は /event/reviews/ (またはこれの逆、たとえば /reviews/event/) /location/reviews/ /thing/reviews/

私が見ることができる問題は、これらのそれぞれの「GET」が親オブジェクト、つまりイベントを返す必要があることです。

では、ServiceStack を使用して、このシナリオを処理する最善の方法は何でしょうか? すぐに使用できる REST セットアップを悪用するのではなく、データ要求ごとにカスタム サービスを作成することですか、それとももっと基本的なことを見逃しているのでしょうか?

4

1 に答える 1

140

まず、「最良の」ソリューションはかなり主観的な用語です。私は通常、最小限の労力、摩擦、おしゃべりを促進する DRY で再利用可能でパフォーマンスの高いソリューションを目指しますが、他の人は REST の原則にどれだけ厳密に従っているかで「最高」と定義するかもしれません。そのため、目標が何であるかに応じて、さまざまな応答が得られます。私はそれにどのようにアプローチするかを提供することしかできません。

ServiceStack サービスの実装は、カスタム ルートから分離されています。

留意すべき点の 1 つは、ServiceStack でサービスを定義および設計する方法と、サービスを公開する方法がかなり分離されていることです。これは、任意のカスタム ルートでサービスを公開できるためです。ServiceStack はメッセージベースの設計を推奨しているため、各操作に個別のメッセージを与える必要があります。

論理的/階層的な URL 構造を使用する

私は論理的な Url 構造を使用して、名詞の識別子を表すことを目指しています。これは階層的に構造化されています。つまり、親パスはリソースを分類し、意味のあるコンテキストを提供します。したがって、この場合、イベントとレビューを公開したい場合は、次の URL 構造を使用する傾向があります。

/events             //all events
/events/1           //event #1
/events/1/reviews   //event #1 reviews

これらの各リソース識別子には、任意の HTTP 動詞を適用できます

実装

実装では、通常、メッセージ ベースの設計に従い、応答タイプと呼び出しコンテキストに基づいて関連するすべての操作をグループ化します。このために、私は次のようなことをします：

[Route("/events", "GET")]
[Route("/events/category/{Category}", "GET")] //*Optional top-level views
public class SearchEvents : IReturn<SearchEventsResponse>
{
   //Optional resultset filters, e.g. ?Category=Tech&Query=servicestack
   public string Category { get; set; } 
   public string Query { get; set; }
}

[Route("/events", "POST")]
public class CreateEvent : IReturn<Event>
{
   public string Name { get; set; }
   public DateTime StartDate { get; set; }
}

[Route("/events/{Id}", "GET")]
[Route("/events/code/{EventCode}", "GET")] //*Optional
public class GetEvent : IReturn<Event>
{
   public int Id { get; set; }
   public string EventCode { get; set; } //Alternative way to fetch an Event
}

[Route("/events/{Id}", "PUT")]
public class UpdateEvent : IReturn<Event>
{
   public int Id { get; set; }
   public string Name { get; set; }
   public DateTime StartDate { get; set; }
}

そして、イベントレビューについても同様のパターンに従います

[Route("/events/{EventId}/reviews", "GET")]
public class GetEventReviews : IReturn<GetEventReviewsResponse>
{
   public int EventId { get; set; }
}

[Route("/events/{EventId}/reviews/{Id}", "GET")]
public class GetEventReview : IReturn<EventReview>
{
   public int EventId { get; set; }
   public int Id { get; set; }
}

[Route("/events/{EventId}/reviews", "POST")]
public class CreateEventReview : IReturn<EventReview>
{
   public int EventId { get; set; }
   public string Comments { get; set; }
}

これらのメッセージに基づいて、実装は非常に単純である必要があり、(コードベースのサイズに応じて) 2つのEventsServiceクラスとEventReviewsServiceクラスに編成します。同じ名前のデータ モデルとの衝突を避けるために、サービス リクエストの DTO 名には複数形を使用していることに注意してください。

ここでは分離UpdateEventしていますが、ユースケースが許せば、CreateEventそれらを 1 つのべき等操作にマージすることがあります。StoreEvent

物理的なプロジェクト構造

理想的には、ルート レベルのAppHostプロジェクトは軽量で実装不要に保つ必要があります。ただし、いくつかのサービスしかない小さなプロジェクトの場合は、すべてを 1 つのプロジェクトにまとめて、必要に応じてアーキテクチャを単純に拡張しても問題ありません。

中規模から大規模のプロジェクトの場合、以下の物理構造をお勧めします。この例では、アプリケーションがEventManと呼ばれると想定します。

プロジェクトの順序もその依存関係を示します。たとえば、最上位のプロジェクトはすべてのサブ プロジェクトをEventMan参照し、最後のプロジェクトはnoneを参照します。EventMan.ServiceModel

- EventMan
    AppHost.cs              // ServiceStack ASP.NET Web or Console Host Project

- EventMan.ServiceInterface // Service implementations (akin to MVC Controllers)
    EventsService.cs
    EventsReviewsService.cs

- EventMan.Logic            //For larger projs: pure C# logic, data models, etc
    IGoogleCalendarGateway  //E.g of a external dependency this project could use

- EventMan.ServiceModel     //Service Request/Response DTOs and DTO types
    Events.cs               //SearchEvents, CreateEvent, GetEvent DTOs 
    EventReviews.cs         //GetEventReviews, CreateEventReview
    Types/
      Event.cs              //Event type
      EventReview.cs        //EventReview type

DTO を独自の個別の実装と依存関係のない dll に保持することで、この dll を任意の .NET クライアント プロジェクトでそのまま自由にEventMan.ServiceModel共有できます。 -コード生成なしの型付き API を終了します。

アップデート

于 2013-03-05T23:01:15.657 に答える