Web APIが単純なCRUDでない場合はどうすればよいですか？

Question

RESTful Web APIのベストプラクティスについていくつか質問があります。

インターフェイスを簡素化するために、GET,PUTおよびPOSTなどのHTTPプロトコルを使用することが標準と思われます。

GET /チケット - チケット
GET /チケット/ 12のリストを取得します - 特定のチケットに
POST /チケットを取得します - 新しいチケットを作成します
PUT /チケット/ 12 - アップデートチケット＃12
PATCH /チケット/ 12 - 部分的にアップデートチケット＃12
DELETE /チケット/ 12は - チケット＃12

を削除します。しかし、私の最初のAPIを開発してしばらく過ごした後、私は本当にそれは私が落ちる感じませんそのようなきちんとしたデザイン。

私のAPIはの追加または更新をサポートしています。呼び出し元は一度に任意の数のLineItemを追加または更新できます。さらに、番号を確認または取り消すことができます。追加および更新の場合、多くの追加の関連データも供給されている。確認や取り消しのために、必要なデータはずっと少なくて済みます。

これは、上記のチケットインターフェイスにどのように適合しますか？私は悪いWeb APIを作成していますか？受け入れられた基準は他のバリエーションを考慮していますか？これについて議論する良いリンクはありますか？

Answer 1

オブジェクト全体のCRUDタスクよりも具体的なタスクを行うメソッドをクラスに持たせることができます。だから、あなたのTicketオブジェクトは、ラインのアイテムを持っていると仮定して、あなたはPUTを持っているかもしれないようにURIを呼び出します。

PUT /チケット/ 12 /のLineItemコードで名= BLAH &アドレス= FOO

あなたの方法でしょうか？それで何かのようになります

public class TicketController 
{ 
    [HttpPut] 
    [ActionName("LineItem")] 
    public HttpResponseMessage UpdateLineItem(int id, string name, string address) 
    { 
     // Do stuff here. 
    } 
} 

明らかにあなたの他の方法もそこに入れます。おそらく、それを変更して、広告申込情報の情報がURIではなくPUTまたはPOSTの本体を経由するようにしたいのですが、URI引数の仕組みも表示すると便利です。

問題でLineItem sがTicket秒に関連ていない場合は、あなたがそれらを置くためにいくつかの他のコントローラを見つける必要があり