2012-03-09 13 views
0

私は主に内部的に使用されるAPIを作成していますが、今後はRESTfulなインターフェースを作成するのが簡単にできるように作成します。私はすべての細部にこだわってきましたが、基本的な荒れた操作の正確なメソッド名を除いて、私はすべてを釘付けにしました。私はそれを見るように、私はいくつかのオプションがありますあります、読むポスト ベストプラクティス:CRUD操作の推奨用語は何ですか?

  • 、追加、新規

    1. を作成
    2. 更新、編集を取得し、削除
    3. を入れ、

    を削除しますおそらくもっと...

    私は "add、get、edit、delete"に向かっています。 RESTfulなインターフェイスは内部APIのセカンダリなので、対応するHTTPメソッドと一緒にそれらの名前を付けてもおそらくあまり意味がありません(標準Dev:「なぜ、編集メソッドは「put」と呼ばれますか? ")。

    そして私は人生においてはるかに重要なことがあることをよく知っています! ;)

  • +3

    PUTは実際には編集よりも優れています。 – abraham

    答えて

    1

    私はHTTPメソッド名を使用する方が好きです。私は最後に、他の開発者が読みやすくすることがわかりました。

    この戦略は、ASP.Net MVC4のWeb APIにもデフォルトのものである:

    public class SomeRestController : ApiController 
    { 
        public IEnumerable<Entity> Get() { ... } 
    
        public Entity Get(int id) { ... } 
    
        public HttpResponseMessage Post(Entity e) { ... } 
    
        public void Put(int id, Company c) { ... } 
    
        public HttpResponseMessage Delete(int id) { ... } 
    } 
    

    あなたが設計しているアプリケーションは完全にAPIから取り外されている場合は、おそらくあなたが集・としてメソッドに名前を付ける必要があります(取得、追加、削除など)

    関連する問題