كاتب واجهة برمجة التطبيقات
كاتب واجهات برمجة التطبيقات (API) هو كاتب تقني يكتب وثائق تصف واجهة برمجة التطبيقات (API). ويشمل جمهوره الأساسي المبرمجين والمطورين ومهندسي النظم ومصممي النظم.
ملخص
واجهة برمجة التطبيقات (API) هي مكتبة تتكون من واجهات، ووظائف، وفئات ، وهياكل، وتعدادات، وغيرها، تُستخدم لبناء تطبيقات برمجية. يستخدمها المطورون للتفاعل مع البرنامج وتوسيعه. قد تتكون واجهة برمجة التطبيقات للغة برمجة أو نظام معين من بنيات مُعرَّفة من قِبل النظام وأخرى مُعرَّفة من قِبل المستخدم. مع ازدياد عدد هذه البنيات وتعقيدها، يصبح من الصعب على المطورين تذكر جميع الوظائف والمعاملات المُعرَّفة. لذا، يلعب مطورو واجهات برمجة التطبيقات دورًا محوريًا في بناء التطبيقات البرمجية .
نظراً لطبيعة الموضوع التقنية، يجب على مطوري واجهات برمجة التطبيقات (APIs) فهم شفرة المصدر للتطبيقات بشكل كافٍ لاستخراج المعلومات المطلوبة في وثائق واجهة برمجة التطبيقات. غالباً ما يستخدم مطورو واجهات برمجة التطبيقات أدوات تستخرج وثائق البرامج التي يضعها المبرمجون في شفرة المصدر بطريقة منظمة، مع الحفاظ على العلاقات بين التعليقات وبنيات البرمجة التي توثقها.
يجب على مطوري واجهات برمجة التطبيقات (APIs) فهم المنتج البرمجي وتوثيق الميزات الجديدة أو التغييرات كجزء من إصدار البرنامج الجديد. يختلف جدول إصدارات البرامج من مؤسسة إلى أخرى. يحتاج مطورو واجهات برمجة التطبيقات إلى فهم دورة حياة البرمجيات جيدًا والاندماج في دورة حياة تطوير الأنظمة (SDLC).
يتبع كتّاب واجهات برمجة التطبيقات في الولايات المتحدة عمومًا دليل شيكاغو للأسلوب فيما يتعلق بالقواعد النحوية وعلامات الترقيم .
المؤهلات
يمتلك كتّاب واجهات برمجة التطبيقات عادةً مزيجًا من مهارات البرمجة واللغات؛ فالعديد منهم لديهم خلفيات في البرمجة أو الكتابة التقنية .
- خلفية في برمجة الحاسوب (معرفة بلغات البرمجة C أو C++ أو Java أو PHP أو غيرها )
- معرفة معايير التنسيق مثل Doxygen و Javadoc و OpenAPI أو DITA
- معرفة بالمحررات والأدوات، مثل FrameMaker
- مهارات تواصل وكتابة ممتازة للتفاعل مع المطورين
- معرفة أداة cURL حتى يتمكنوا من العمل مع واجهات برمجة التطبيقات المستندة إلى HTTP
- معرفة Swagger ، وهو معيار لتوثيق واجهات برمجة التطبيقات وأداة توصيلها، والتي تزداد شعبيتها بين المطورين.
يمكن لكتاب واجهات برمجة التطبيقات (API) ومجموعات تطوير البرامج (SDK) الخبراء أن يصبحوا بسهولة كتاب برامج .
عملية كتابة واجهة برمجة التطبيقات (API)
عادةً ما تنقسم عملية كتابة واجهات برمجة التطبيقات (APIs) إلى مراحل تحليل وفهم شفرة المصدر ، والتخطيط، والكتابة، والمراجعة. وفي كثير من الأحيان، لا تسير هذه المراحل الثلاث بشكل خطي تمامًا.
تختلف معايير الكتابة والتقييم بين المؤسسات. تُكتب بعض وثائق واجهة برمجة التطبيقات (API) الأكثر فعالية من قِبل أشخاص لديهم القدرة الكافية على فهم آلية عمل تطبيق معين، بحيث يمكنهم ربط البرنامج بالمستخدمين أو ربط مكوناته المختلفة بالغرض العام للبرنامج. وقد يكون كتّاب واجهة برمجة التطبيقات مسؤولين أيضًا عن كتابة وثائق المنتج للمستخدم النهائي .
مع أن الوثائق المرجعية قد تُنشأ تلقائيًا لضمان اكتمالها، إلا أن الوثائق التي تساعد المطورين على البدء ينبغي أن يكتبها كاتب متخصص في واجهات برمجة التطبيقات (API) وأن يراجعها خبراء في المجال. [ 1 ] وهذا يضمن فهم المطورين للمفاهيم الأساسية وقدرتهم على البدء بسرعة.
منتج
يقوم كتّاب واجهات برمجة التطبيقات (API) بإنتاج وثائق تتضمن ما يلي:
- أدلة مرجعية لواجهة برمجة التطبيقات (API)
- أدلة المبرمجين
- أدلة المطورين
- كتيبات الإدارة
- أدلة التثبيت
- أدلة التنفيذ والتكامل
انظر أيضاً
مراجع
- واجهات برمجة التطبيقات
- وثائق البرمجيات