توثيق APIالوثائق التقنية

توثيق API من أوصاف نقاط النهاية لديك

التسليم من 1 يومالتعديلات مشمولةفحص الجودة
الباقات
حماية الدفعالتفاصيل
  • التعديلات ضمن الباقة مجانية.
  • إذا لم تردّ خلال 3 أيام من التسليم، يُقبل العمل تلقائيًا.
اطلب · ‏39 US$

يُحجز المبلغ عند الدفع ولا يُحوَّل إلا بعد قبولك العمل.

توثيق API من أوصاف نقاط النهاية لديك

مثال على النتيجة

مثال على الباقة القياسية

مجموعة إجراءات تشغيل قياسية: فتح وإغلاق مقهى صغير

SOP-02: إغلاق المقهى

الغرضترك المقهى نظيفًا وآمنًا وجاهزًا لمناوبة الصباح
المسؤولباريستا الإغلاق؛ ويوقّع رئيس المناوبة
التوقيتالبدء 5:30 مساءً، قفل الأبواب 6:00، الانتهاء بحلول 6:45
تحتاج إلىورقة قائمة الإغلاق، مفتاح الصندوق، حقيبة أدوات التنظيف، الفوط الزرقاء

قبل أن تبدأ

تحذير: لا تطفئ القاطع الرئيسي في الجدار أبدًا. الثلاجات وجهاز الإنذار على اللوحة نفسها.

الخطوات

  1. في 5:30 مساءً، اقلب لافتة الباب إلى "آخر الطلبات". يمكن للزبائن الموجودين البقاء حتى 6:00.
  2. حوّل آلة القهوة إلى وضع الشطف. اضغط زر الكوب مطولًا 5 ثوانٍ. ما يجب أن تراه: كلمة "RINSE" تومض على الشاشة وماء ساخن يجري في رأسي الاستخلاص نحو دقيقتين.
  3. أخرج حوامل البن وانقعها في الحاوية السوداء مع قرص تنظيف واحد. اتركها 20 دقيقة.
  4. انقل الكعك والسندويشات إلى الثلاجة الخلفية. ضع على كل ما فُتح اليوم ملصقًا بتاريخ اليوم و"يُستهلك غدًا".
  5. سجّل حرارة الثلاجات في ورقة السجل. ما يجب أن تراه: بين 1 °م و5 °م. إن تجاوزت ثلاجة 5 °م، فانتقل إلى الخطوة 12 أولًا.
  6. في 6:00 مساءً، اقفل الباب الأمامي واقلب اللافتة إلى "مغلق".
  7. أغلق الصندوق. اضغط MENU، ثم "نهاية اليوم"، ثم "تقرير Z". ما يجب أن تراه: التقرير يُطبع بإجمالي اليوم. لا تعدّ النقود عند الكاونتر؛ خذ الدرج إلى المكتب.

(الخطوات 8–14: الأرضيات، والنفايات، والإنذار، ومذكرة التسليم.)

إذا حدث خلل

المشكلةماذا تفعل
ثلاجة فوق 5 °مانقل الطعام إلى الثلاجة الثانية، وسجّل الوقت والحرارة، وأرسل رسالة إلى رئيس المناوبة
تقرير Z لا يُطبعاستبدل لفة الورق؛ وإن استمر العطل، اكتب الإجمالي من الشاشة وصوّره
الإنذار لا يتفعّلتأكد من إغلاق الباب الخلفي تمامًا؛ فالإنذار لا يعمل والباب مفتوح

التوقيع

باريستا الإغلاق: الاسم، الوقت. رئيس المناوبة: الأحرف الأولى.

آخر مراجعة: [التاريخ]. تُراجع مجددًا عند استبدال آلة القهوة أو الصندوق.

العميل: مقهى الجُلّنار، 22 مقعدًا، 7 موظفين بمناوبات متناوبة المدخلات: رسائل صوتية من المالكة، وقائمة تحقق مكتوبة بخط اليد، و9 صور للكاونتر وآلة القهوة وشاشة الصندوق المُسلَّم: 6 إجراءات تشغيل قياسية (4,600 كلمة): الفتح، الإغلاق، التعامل مع النقد، سجل حرارة الثلاجات، التنظيف العميق لآلة القهوة، التعامل مع شكوى زبون. أدناه: مقتطف من إجراء الإغلاق.

العميل وجميع التفاصيل افتراضية.

عن هذه الخدمة

يحكم المطورون على أي API من توثيقها خلال دقائق: إذا لم تنجح المصادقة أو الطلب الأول، يغادرون. نكتب مرجع API والأدلة من أوصاف نقاط النهاية أو ملف OpenAPI أو أمثلة الشيفرة لديك: المصادقة، وعناوين URL الأساسية، وكل نقطة نهاية بمعاملاتها، وأمثلة الطلبات والاستجابات، ورموز الأخطاء، وحدود المعدل، والتقسيم إلى صفحات. ويعرض دليل البدء السريع أول استدعاء ناجح في خطوات قليلة.

ما المشمول

  • ما الذي تحصل عليهتوثيق API بصيغة Markdown مع كتل الشيفرة، جاهز لـ ReadMe أو GitBook أو Docusaurus أو مستودعك. نكتب مما ترسله ولا نستدعي API الخاصة بك بأنفسنا.
  • البدء السريعمن مفتاح API إلى أول استدعاء
  • مرجع نقاط النهايةالمعاملات، الأنواع، الأمثلة
  • الأخطاء والحدودالرموز، المعاني، نصائح إعادة المحاولة
  • أمثلة الشيفرةcURL إضافةً إلى لغة واحدة تختارها
  • مصطلحات متسقةالأسماء نفسها كما في مخططك

كيف يعمل

  1. 1
    متطلبات الطلبتلصق أو ترفق نقاط النهاية والأمثلة
  2. 2
    الهيكل والكتابةنكتب المرجع والأدلة
  3. 3
    التسليمتستلم Markdown جاهزًا للنشر

ما نحتاجه منك

أوصاف نقاط النهاية أو ملف OpenAPI أو Postman ملصوقًا كنص، وتفاصيل المصادقة، وأمثلة الطلبات والاستجابات، ورموز الأخطاء، ومن هم مستخدمو API لديك.

سنسألك:

  • ماذا تفعل API، ومن يستخدمها؟
  • كيف تعمل المصادقة؟
  • ما اللغة التي يجب أن تستخدمها أمثلة الشيفرة إلى جانب cURL؟
  • أين سيُنشر التوثيق؟

قارن بين الباقات

الباقاتالأساسيةبدء سريع وحتى 5 نقاط نهاية‏19 US$القياسيةحتى 20 نقطة نهاية مع أدلة‏39 US$المميزةحتى 50 نقطة نهاية، توثيق كامل‏79 US$
مدة التنفيذ1 يوم3 أيام5 أيام
التعديلات123
الطولحتى 2,000 كلمةحتى 6,000 كلمةحتى 14,000 كلمة
نقاط النهايةحتى 5حتى 20حتى 50
لغات أمثلة الشيفرةcURLcURL + 1cURL + 2
اطلب الأساسيةاطلب القياسيةاطلب المميزة

حماية الدفع

تدفع عند الطلب، لكن المبلغ لا يُحوَّل إلا مقابل عمل قبلته.

  • سعر ثابتلا يتغير سعر الباقة بعد الدفع.
  • المبلغ محجوزعند الدفع، يُحجز المبلغ فقط. ولا يُحوَّل إلى Dleex إلا بعد قبولك العمل.
  • فحص قبل التسليمتخضع كل نتيجة لفحص الجودة قبل أن تصل إليك، وتراها في صفحة الطلب قبل قبولها.
  • تعديلات مجانيةاطلب تعديلات ضمن متطلبات طلبك بالعدد الذي تسمح به الباقة.
  • القبول بعد 3 أيامإذا لم تقبل العمل ولم تطلب تعديلات خلال 3 أيام من التسليم، يُقبل تلقائيًا. وإذا كتبت في محادثة الطلب بعد التسليم، يبقى الطلب قيد الانتظار؛ وبعد ردّنا، قد نعيد بدء مهلة 3 أيام وسنُعلمك بذلك في المحادثة.
  • إعادة التنفيذ أو استرداد المبلغ كاملًاإذا لم تطابق النتيجة متطلبات طلبك ولم تُصلحها التعديلات، أو استغرق العمل أكثر من ضعف مدة التنفيذ، فاكتب في محادثة الطلب: سنعيد تنفيذ العمل أو نردّ إليك المبلغ كاملًا.
كيف يعمل →

الأسئلة والأجوبة

هل يمكنكم العمل من مواصفات OpenAPI الخاصة بنا؟

نعم، الصق ملف YAML أو JSON في متطلبات الطلب. نحوّل أوصافه إلى صفحات مرجعية مقروءة ونملأ الثغرات التي تشير إليها.

هل ستختبرون الأمثلة؟

لا نستدعي API الخاصة بك. تُبنى الأمثلة من نماذج الطلبات والاستجابات التي ترسلها، لذا شغّلها مرة واحدة قبل النشر.

هل تكتبون توثيق SDK؟

نعم، إذا أرسلت تواقيع الدوال وأمثلة الاستخدام. تُحتسب كل SDK ضمن حجم الباقة.

الباقات
اطلب · ‏39 US$· 3 أيام