पोस्ट/पुट के लिए यूआरआई टेम्पलेट

Question

मैं एक आराम से एपीआई लिखने जा रहा हूं, मेरी आवश्यकता है "लेनदेन" ऑब्जेक्ट पर विधियों को कॉल करना, मैं सोच रहा था कि मुझे उचित यूआरआई टेम्पलेट के साथ पोस्ट/पुट कैसे कॉल करना चाहिए ताकि मैं कर सकूं उरी मैपिंग में "क्रियाएं" का उपयोग किये बिना लेनदेन संसाधन बनाएं/अपडेट करें।

[OperationContract] 
[WebInvoke(Method = "POST", UriTemplate = "/Transaction/{**What to write here ????**}", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)] 
public Transaction AddTransaction(Transaction transaction) 
{ 
    return AddTransactionToRepository(transaction); 
} 

[OperationContract] 
[WebInvoke(Method = "PUT", UriTemplate = "/Transaction/{**What to write here ????**}", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)] 
public Transaction UpdateTransaction(Transaction transaction) 
{ 
    return UpdateTransactionInRepository(transaction); 
} 

कृपया विचार है कि मैं uri मानचित्रण के लिए सबसे अच्छा अभ्यास लागू करना चाहते हैं और verbs "" उस में, केवल "संज्ञाओं" नहीं करना चाहती। यह भी बताएं कि ग्राहक अद्वितीय यूआरआई के साथ पोस्ट और पुट के लिए इन तरीकों का उपयोग कैसे करेगा। धन्यवाद

Answer 1

आपको Transaction के लिए नीचे यूआरआई को मानचित्र करना होगा।

आईडी से कोई लेन-देन प्राप्त करें - प्राप्त - पोस्ट - - लेन-देन/आईडी

एक नई लेन-देन बनाएं लेनदेन

अद्यतन एक सौदे - PUT - लेन-देन/आईडी

एक सौदे हटाएँ - DELETE - लेन-देन/आईडी

आपका यूआरआई टेम्पलेट्स

[OperationContract] 
[WebInvoke(Method = "POST", UriTemplate = "/Transaction", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)] 
public Transaction AddTransaction(Transaction transaction) 
{ 
    // 
} 

[OperationContract] 
[WebInvoke(Method = "PUT", UriTemplate = "/Transaction/{id}", RequestFormat = WebMessageFormat.Json, ResponseFormat = WebMessageFormat.Json)] 
public Transaction UpdateTransaction(int id, Transaction transaction) 
{ 
    // 
} 

नीचे कैसे ग्राहक पोस्ट के लिए इन तरीकों का उपयोग और अद्वितीय यूआरआई

साथ रखो के रूप में परिवर्तित करने की है

आपको पोस्ट और पुट के लिए अद्वितीय यूआरआई की आवश्यकता नहीं है। वहां यूआरआई समान हो सकते हैं।

संदर्भ: http://www.asp.net/web-api/overview/creating-web-apis/creating-a-web-api-that-supports-crud-operations

http://msdn.microsoft.com/en-us/library/bb412172(v=vs.90).aspx

Answer 2

PUT बनाने या एक ज्ञात संसाधन अद्यतन करने, उदाहरण के लिए के लिए है: डाल/लेन-देन/1234

यह (अगर यह पहले से मौजूद है या अद्यतन) बनाना होगा इसका मतलब है आप केवल कर सकते हैं आईडी 1234. साथ लेन-देन जब आप संसाधन के यूआरएल को जानते हैं तो PUT का उपयोग करें।

पोस्ट उदाहरण के लिए, एक नए बच्चे संसाधन बनाता है: पोस्ट/लेन-देन/

यह एक नई लेन-देन संसाधन पैदा करेगा।

नोटिस मैंने लेनदेन को बहुवचनित किया है, इसलिए अब यह एक संग्रह का प्रतिनिधित्व करता है।

सी # डेवलपर नहीं है, मुझे नहीं पता कि यह मानचित्र डब्ल्यूसीएफ के लिए कितना आसान है, लेकिन यह दृष्टिकोण प्रौद्योगिकी-स्वतंत्र है।

Answer 3

उचित यूआरएल और एपीआई डिजाइन सिद्धांतों बनाने के लिए ... मैं इस ebook (मेरा नहीं मिला!) एक अवश्य पढ़ें: http://offers.apigee.com/api-design-ebook-rr/