RESTを使用した通知のジレンマデザイン

Question

他のインターフェイスやマイクロサービスによってトリガされるすべての通知（電子メール、SMSなど）の実行を担当するマイクロサービスを作成しています。これは、すべての通知ロジックと処理を集中化するためです。通知アクションは、残りのWebサービスURLを呼び出すことによってトリガーされます。

これが私のジレンマです。リクエストの種類ごとに1つのURLを作成するのか、すべてのURLを1つ作成するのですか？

OPTION1

@Path("{sourceId}/registationEmail") 
@Path("{sourceId}/forgotPasswordEmail") 
@Path("{sourceId}/productionTicketEmail") 
@Path("{sourceId}/registationSms") 
@Path("{sourceId}/forgotPasswordSms") 
@Path("{sourceId}/productionTicketSms") 

または

OPTION 2

@Path("{sourceId}/email") 
@Path("{sourceId}/sms") 

は、ここでの問題は、その通知のすべてのタイプがの異なるセットを持っているだろう、我々は、入力として@BeanParamを使用しているあります入力値。それがオプション2に向けて決定する主な問題ですか、それともREST構成で回避する方法がありますか？

Answer 1

Richardson Maturity Model level 1を見ると、実際には2つのリソース（別名オプション2）があり、どちらもタイププロパティを持つことができます。もちろん、彼らは入力値の異なるセットを持つつもりですが、それらのすべての電子メールタイプは、正しい（From、To、Subject、Bodyなど）、同じプロパティを持つ必要がありますか？それが2つの他のものと同じように見え、動作するならば、別個のエンドポイントを有することには意味がない。

Answer 2

私はオプション2のために行くだろう：それは他の選択肢よりもはるかに良く見える

@Path("{sourceId}/email") 
@Path("{sourceId}/sms") 

。

---

私はあなたの完全なURIがどのようなものかわからないが、私は/sources/{sourceId}/emailか/sources/{sourceId}/notification/emailのようなものを持っているでしょう。

そして、あなたの要求は次のように次のようになります。あなたはあなたの入力がどのように見えるかについての詳細を提供していない

POST /sources/{sourceId}/email HTTP/1.1 
Host: example.com 
Content-Type: application/json 

{ 
    "to": "mail@example.com", 
    "subject": "Question 38602123", 
    "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit." 
} 

---

。使用している依存関係についての詳細はありません。したがって、推測して決定的な答えをあなたに提供するのは難しいです。

あなたは@BeanParamと言っていますので、JAX-RSとJerseyなどの実装の1つを使用しているとします。リソースを表すためにJSONやXMLを使用している場合は、Jacksonを使用している可能性が非常に高いです。

したがって、さまざまな入力を処理するために、継承とジャクソンのポリモーフィックなデシリアライズを使用できます。トリックを行う@JsonTypeInfoと@JsonSubTypesのようないくつかの注釈があります。