Apiary: هل من الممكن توثيق حقول استجابة JSON؟

Question

أود أن توثق ما يمثله حقول JSON الفعلية نفسها.

قمت بتوثيق عبارة Get، والمعلمات، ولكن هذا لا يقوم بتوثيق كاملة لإعطاء المستخدمين.

لذلك، في المثال أدناه، كيف يمكنني إضافة تعليق حول "لفائف أخرى".هل هذا مدعوم؟أو هل أحتاج إلى إنشاء وثيقة رفيق في مكان آخر.

giveacodicetagpre.

Answer 1

Update: لقد خرجنا للتو من وصف بيتا من السمات باستخدام بناء جملة MSON .

يمكن أن يتم وصف الحمولة الأصلية عند

giveacodicetagpre.

لاحظ أن JSON الصريح في الجسم أمر زائد ويمكنك تخطيه تماما.انظر API Blueprint المواصفات - السمات للحصول على تفاصيل إضافية

Answer 2

لا أعتقد أنه مدعوم بعد.

قمت بحل هذه المشكلة في مشروعي عن طريق وضع جدول مع الوصف مباشرة أعلى سطر طلب الحصول عليه.في حالتك قد تبدو وكأنها:

giveacodicetagpre.

لمساعدتك في إنشاء الجدول في بناء جملة تخطيطي يمكنك استخدام Markdown Tables Generator .

لاحظ أن مولد الجدول يتيح لك حفظ تعريف الجدول إلى ملف، لذلك في المرة القادمة، ستحتاج إلى تحرير الجدول، يمكنك البدء من حيث توقفت.