तो मान लें कि मेरे पास एक 200
प्रतिक्रिया है कि कौन सा शरीर होना चाहिए:
{
"data": [
{
"id": 1,
"title": "Activity 1"
},
{
"id": 1,
"title": "Activity 2"
}
]
}
मैं एपीआई ब्लूप्रिंट में इसका उपयोग करके प्रतिक्रिया निकाय के इस व्यवहार को प्राप्त करने में कामयाब रहा हूं।
+ Response 200 (application/json)
+ Attributes
+ data (array[Activity])
(ध्यान दें कि मैं डेटा संरचना में डेटा कुंजी नहीं जोड़ सकता, क्योंकि यह केवल एक प्रतिक्रिया पर मौजूद है। अगर मुझे किसी अन्य संरचना के अंदर गतिविधि को घोंसला बनाने की आवश्यकता है, तो इसमें डेटा कुंजी नहीं होनी चाहिए।)
यह सही नहीं लगता
इसका कारण यह है कि मुझे नहीं लगता कि यह करने का यह सही तरीका है, इस प्रतिक्रिया के लिए JSON स्कीमा की वजह से है:
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"data": {
"type": "array"
}
}
}
ध्यान दें कि वास्तविक गतिविधि को कैसे बाहर रखा गया है।
मैं अपनी प्रतिक्रिया को डेटा कुंजी में ठीक से कैसे लपेट सकता हूं, और क्या यह शरीर और स्कीमा दोनों में परिलक्षित होता है?
1 उत्तर
आपको इस लाइन का उपयोग करना चाहिए:
+ data(array[Activity], fixed-type)
fixed-type
कीवर्ड सरणी में आइटम्स के प्रकार को ठीक करता है।
संबंधित सवाल
नए सवाल
apiblueprint
एपीआई ब्लूप्रिंट HTTP एपीआई का वर्णन करने के लिए एक मार्कडाउन-आधारित डीएसएल है।