2014-09-23 4 views
6

में यूआरआई पैरामीटर का वर्णन करना मैं RAML में एक आरईएसटी सेवा एपीआई स्टब घोषित कर रहा हूं। मेरा वेब एप्लिकेशन उपकरण प्रदान करता है, जिसे आईडी या कोड द्वारा प्राप्त किया जा सकता है। जब मैं पूरी सूची चाहता हूं, तो मैं किसी भी यूआरआई पैरामीटर को निर्दिष्ट नहीं करता हूं, हालांकि, एक ठोस उपकरण प्राप्त करने के लिए, मैं करता हूं।आरएएमएल

/equipment: 
    get: 
     body: 
     application/json: 
     application/xml: 
    description: 
     List all the equipment 
    /id/{equipmentId}: 
     get: 
     body: 
      application/json: 
      application/xml: 
     description: 
     Get an equipment by id 
    /code/{code}: 
     get: 
      body: 
      application/json: 
      application/xml: 
     description: 
       Get an equipment by code 

यहाँ, description क्षेत्रों में मैं क्या वर्तमान कॉल प्रदर्शन लिखने: यह अपनी वर्तमान स्थिति है। हालांकि, मैं यूआरआई में पारित पैरामीटर के लिए एक विवरण जोड़ना चाहता हूं (id या code)। क्या इसे हासिल करने का कोई तरीका है?

उत्तर

7

equipmentId और code पैरामीटर का वर्णन करने के लिए आप uriParameters अनुभागों को खो रहे हैं। इस तरह के अनुभाग में, आप हमेशा की तरह निर्दिष्ट कर सकते हैं: type, description ...

देखें अनुभाग खाका यूआरआई और यूआरआई पैरामीटर कल्पना में: https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md#template-uris-and-uri-parameters