Apidoc: जटिल (नेस्टेड हैश) पैरामीटर का वर्णन कैसे करें?

को निर्मित 4 दिस॰ 2015 · 8टिप्पणियाँ · स्रोत: apidoc/apidoc

नमस्ते,

मैं विधियों का एक समूह दस्तावेज करना चाहता हूं जो सभी नेस्टेड हैश को एकल पैरामीटर के रूप में लेते हैं और नेस्टेड हैश भी वापस करते हैं। (इस तरह के डिजाइन का औचित्य यह है कि पसंद की निर्धारित भाषा PHP है जो नामित तर्कों की अनुमति नहीं देती है)।

जैसे (ढीले JSON में व्यक्त)

{
  "foo": [
    {"bar": 1, "baz": "quux"}, // <--- can not find way to document these ones
    {"bar": 2, "baz": "quuz"}
  ]
}

मुझे गहराई से कुंजियों को ठीक से निरूपित करने का कोई तरीका नहीं मिला। कोशिश की जो जल्दी से दिमाग में आया - दोनों फ़ील्ड नामों और समूहों के लिए कृत्रिम हैश के रूप में बिंदीदार नोटेशन लेकिन सफलता के बिना।

टीआईए,
--व्लादिमीर

developer needed

स्रोत

dvv

सबसे उपयोगी टिप्पणी

आश्चर्य है कि नमूना यूआरएल का उपयोग करने के लिए फॉर्म भरते समय सरणी फ़ील्ड कैसे भरें?

dvv 21 अप्रैल 2016

👍2

सभी 8 टिप्पणियाँ

@dvv यहाँ हमारे डॉक्स (सफलता

* <strong i="7">@apiSuccess</strong> (Response Fields) {Object} images map of image maps
* <strong i="8">@apiSuccess</strong> (Response Fields) {Object} images.poster map of poster properties
* <strong i="9">@apiSuccess</strong> (Response Fields) {String} images.poster.asset_id asset id for the poster
* <strong i="10">@apiSuccess</strong> (Response Fields) {Object[]} images.poster.sources array of poster source maps
* <strong i="11">@apiSuccess</strong> (Response Fields) {Url} images.poster.sources.src URL for a poster source image
* <strong i="12">@apiSuccess</strong> (Response Fields) {Url} images.poster.src URL for the default poster source image
* <strong i="13">@apiSuccess</strong> (Response Fields) {Object} images.thumbnail map of thumbnail properties
* <strong i="14">@apiSuccess</strong> (Response Fields) {String} images.thumbnail.asset_id asset id for the thumbnail
* <strong i="15">@apiSuccess</strong> (Response Fields) {Object[]} images.thumbnail.sources array of thumbnail source maps
* <strong i="16">@apiSuccess</strong> (Response Fields) {Url} images.thumbnail.sources.src URL for a thumbnail source image
* <strong i="17">@apiSuccess</strong> (Response Fields) {Url} images.thumbnail.src URL for the default thumbnail source image

मुझे लगता है कि यह आपको विचार देगा।

आप देख सकते हैं कि आउटपुट यहां कैसा दिखता है (हल्के से अनुकूलित टेम्पलेट): http://docs.brightcove.com/en/video-cloud/cms-api/references/cms-api/versions/v1/index.html#api -वीडियो-Get_Videos

rcrooks 4 दिस॰ 2015

👍1

समझा। शुक्रिया।

dvv 7 दिस॰ 2015

हाय @rcrooks कृपया इस
{"उपयोगकर्ता"=>{"टोकन"=>"CAANwSAlT6", "ईमेल"=>" [email protected] "}}

मैं उपरोक्त नेस्टेड हैश के लिए दस्तावेज़ बनाना चाहता हूं। एक कुंजी के रूप में उपयोगकर्ता और इसमें और महत्वपूर्ण मूल्य जोड़े हैं।

ashishsingla89 18 दिस॰ 2015

@ashishsingla89 इसे इस तरह दिखना चाहिए:

* <strong i="7">@apiParam</strong> (Request Fields) {Object} user 
* <strong i="8">@apiParam</strong> (Request Fields) {String} user.token
* <strong i="9">@apiParam</strong> (Request Fields) {String} user.email

rcrooks 18 दिस॰ 2015

👍2

हाय, @rcrooks उत्तर के लिए धन्यवाद।
मैंने उसी तरह से कोशिश की है लेकिन यह इस तरह से अनुरोध करता है -
{"user"=>"", "user.token"=>"GJHGJ67KJL", "user.email"=>"[email protected]"}
लेकिन ऐसा होना चाहिए
{"उपयोगकर्ता"=>{"टोकन"=>"GJHGJ67KJL", "ईमेल"=>" [email protected] "}}

मेरे डॉक्टर में मैंने पैरा के नीचे लिखा है: -

@apiSampleRequest /api/v1/sessions
@apiName लॉगिन
@apiGroup उपयोगकर्ता
@apiDescription उपयोगकर्ता अपना खाता लॉगिन कर सकता है।
@apiParam (उपयोगकर्ता) {ऑब्जेक्ट} उपयोगकर्ता उपयोगकर्ता विशेषताएँ
@apiParam (उपयोगकर्ता) {स्ट्रिंग} user.token उपयोगकर्ता टोकन प्रदान करें
@apiParam (उपयोगकर्ता) {स्ट्रिंग} [user.email] उपयोगकर्ता ईमेल प्रदान करें

अगर मैं गलत पैरामीटर जोड़ रहा हूं तो कृपया मुझे सुधारें

ashishsingla89 20 दिस॰ 2015

आह, हाँ, अनाम नेस्टेड ऑब्जेक्ट एक चुनौती है जिसे मैं हल करने में सक्षम नहीं हूं - और मैं अन्य कारणों से एपीआईडीओसी की कोशिश-इस सुविधा का उपयोग नहीं कर सकता, इसलिए मुझे इसके बारे में चिंता करने की ज़रूरत नहीं है। माफ़ करना।

rcrooks 20 दिस॰ 2015

@rcrooks ठीक है, धन्यवाद।

ashishsingla89 20 दिस॰ 2015

dvv 21 अप्रैल 2016

👍2

क्या यह पृष्ठ उपयोगी था?

0 / 5 - 0 रेटिंग्स

Apidoc: जटिल (नेस्टेड हैश) पैरामीटर का वर्णन कैसे करें?

सबसे उपयोगी टिप्पणी

सभी 8 टिप्पणियाँ

संबंधित मुद्दों