أداة توثيق أخرى لـ Json

هناك العديد من أدوات توثيق بنية JSON ، لقد قمت ببناء واحدة أخرى لعملي المكتبي .//jsondoc.online

بالنسبة لي يمكنني تصنيفهم في:

1. كود أدوات الديكور

الأدوات التي تتطلب إضافة تعليق توضيحي في التعليمات البرمجية ثم تقوم الأدوات بإنشاء وثائق لها على سبيل المثال: swagger

2. أدوات تعريفية

الأدوات التي تتطلب ملء النص في مخطط معين ، ثم تقوم الأدوات بتحليله وإنشاء عرض الوثائق. على سبيل المثال: مواصفات مخطط Json

لماذا تنشئ أداة أخرى؟

تتطلب الأدوات الموجودة فهماً قوياً / واضحاً لما تمثله Json

أو

يفترض أن جميع أعضاء الفريق / الفرق يفهمون المخطط لتعريفه / تحريره.

ولكن ، من الناحية العملية ، وجدت أشخاصًا يشاركون استجابة الطلب في google-doc للحصول على الموافقة.

إن Google-doc جيد ولكن عندما أشارك استجابة مقترحة لخدمي بتنسيق Json المتداخل في google-doc ، تكافح الفرق الأخرى لفهمها واللعب بها وصنع نموذج ذهني بديهي لها.

ومن ثم ، تم إنشاء أداة حيث يمكن للمرء:

1. أضف بنية JSON وشاركها برابط.

2. يمكن لفريق آخر اللعب بهيكل شجرة Json.

3. لوحة توثيق حيث يمكن للمرء عرض / إضافة الوثائق.

كود المصدر: //github.com/bhuvangu/jsondoc.online

الدافع: مشكلة شخصية في العمل