Apidoc: सरणी के साथ अनुरोध निकाय

को निर्मित 11 नव॰ 2016 · 7टिप्पणियाँ · स्रोत: apidoc/apidoc

नमस्ते!

मैं इसे कैसे दस्तावेज करूंगा?

POST /batch-insert
[
  { "name": "Name 1" },
  { "name": "Name 2" }
]

मैं समझता हूं कि @apiParam का उपयोग अनुरोध निकाय को दस्तावेज करने के लिए किया जा सकता है, लेकिन <strong i="10">@apiParam</strong> {String[]} name निहित { "name": ["Name 1", "Name 2"] } मुझे लगता है।

enhancement

स्रोत

Znarkus

👍3

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

@ कोक-एनजी आप जो वर्णन कर रहे हैं वह एक अलग एपीआई है। आपके द्वारा परिभाषित दस्तावेज़ निम्नलिखित के अनुरोध का वर्णन करेगा:

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

लेकिन क्या (मेरा मानना है) @Znarkus पूछ रहा था, और जो मैं भी ढूंढ रहा हूं, वह यह है कि एक एपीआई दस्तावेज कैसे करें जो उम्मीद करता है:

 [{ "name": "Name 1" }, { "name": "Name 2" }]

पीएस यह विशेष रूप से प्रासंगिक है यदि आप एपीआईडॉक सुविधा का उपयोग कर रहे हैं जहां आपने इसे प्रत्येक एंडपॉइंट के लिए फॉर्म जेनरेट किया है। वर्तमान में एपीआईडॉक को एंडपॉइंट के लिए फॉर्म जेनरेट करना असंभव है जब तक कि एंडपॉइंट नामित पैरामीटर नहीं लेता (यानी ऑब्जेक्ट लेता है, सरणी नहीं)।

machineghost 7 मार्च 2017

👍4

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

मै तुम्हारा दर्द समझ सकता हू।
जबकि कोई समाधान लागू नहीं किया गया है, मैं अंडरस्कोर का उपयोग करता हूं:
* <strong i="7">@apiParam</strong> {Object[]} _ array of objects with:

यह एपीआई को पर्याप्त सुपाठ्य रखता है ...

dfreire 26 नव॰ 2016

अरे @dfreire _ क्या करता है?

renatoargh 16 दिस॰ 2016

कुछ नहीं। यह सिर्फ एक प्लेसहोल्डर है जिसे प्रलेखन आउटपुट पर पढ़ना आसान है।

dfreire 16 दिस॰ 2016

नमस्ते,
यदि आप कुछ इस तरह का उपयोग करते हैं

 * <strong i="7">@apiParam</strong> {Object[]} [names] A serie of names
 * <strong i="8">@apiParam</strong> {Object} [names.name] A name

यह एक बिल्कुल स्पष्ट और इंडेंट दस्तावेज़ आउटपुट करता है, हालांकि यह इसे apiSampleUrl के साथ सही ढंग से नहीं भेज रहा है।

koko-ng 19 फ़र॰ 2017

👍2

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

 [{ "name": "Name 1" }, { "name": "Name 2" }]

machineghost 7 मार्च 2017

👍4

इस पर कोई अपडेट?

fedemengo 28 अक्तू॰ 2019

@fedemengo नहीं, लेकिन योगदान करने के लिए आपका स्वागत है! ;)

हाल ही में खुले पीआर/मुद्दों की संख्या को कम करने में बहुत काम किया गया है। इस मुद्दे को अंततः संबोधित किया जाएगा। अभी जो मुद्दे बग नहीं हैं उनकी प्राथमिकता कम है।

NicolasCARPi 28 अक्तू॰ 2019

👍1

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

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

Apidoc: सरणी के साथ अनुरोध निकाय

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

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

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