ما هو swagger API .. وماذا يفعل ؟ وهل هى للباك اند ام فرونت اند ؟

نفترض لدينا backend API فيه endpoints معينة GET,POST,PUT,DELETE وإلخ.

اﻵن مطورو تطبيق الجوال الذين سيستخدمون هذا API طلبوا منك أنت مبرمج backend توثيق documentation بطريقة جذابة أي يريدون واجهة وب تظهر لهم كل API Endpoints ، ماذا تفعل كل Endpoint ، ما هي معاملاتها وما هو شكل الـresponse وإلخ وليس ذلك فقط.

يريدون أيضاً من هذه الواجهة تجريب API واللعب به، كيف تقوم أنت بكل هذا ؟

من خلال كتابة ملف يسمى OpenAPI Specification يوصف API الخاص بك بطريقة معينة ومن ثم يمكنك توليد واجهة documentation من هذا الملف، هذا هو عمل swagger API ، إنه طريقة لبناء واجهة documentation جذابة.

إن swagger API هي تقنية backend أما طريقة كتابة الملف فيمكنك التعرف عليها من الرابط التالي:

https://swagger.io/docs/specification/about/

بعض backend frameworks تدعم swagger API بإحدى طريقتين: إما توليد routes من ملف openapi أو توليد ملف openapi من routes المعرفة والتي يضاف عليها annotation معينة.

أنا أنصح ﻷي backend API أن يكون موثقاً بالـOpenAPI لما فيه من مرونة ولجمال واجهة documentation التي يولدها.

بتاريخ الآن قال أحمد حبنكة:

نفترض لدينا backend API فيه endpoints معينة GET,POST,PUT,DELETE وإلخ.

اﻵن مطورو تطبيق الجوال الذين سيستخدمون هذا API طلبوا منك أنت مبرمج backend توثيق documentation بطريقة جذابة أي يريدون واجهة وب تظهر لهم كل API Endpoints ، ماذا تفعل كل Endpoint ، ما هي معاملاتها وما هو شكل الـresponse وإلخ وليس ذلك فقط.

يريدون أيضاً من هذه الواجهة تجريب API واللعب به، كيف تقوم أنت بكل هذا ؟

من خلال كتابة ملف يسمى OpenAPI Specification يوصف API الخاص بك بطريقة معينة ومن ثم يمكنك توليد واجهة documentation من هذا الملف، هذا هو عمل swagger API ، إنه طريقة لبناء واجهة documentation جذابة.

إن swagger API هي تقنية backend أما طريقة كتابة الملف فيمكنك التعرف عليها من الرابط التالي:

https://swagger.io/docs/specification/about/

بعض backend frameworks تدعم swagger API بإحدى طريقتين: إما توليد routes من ملف openapi أو توليد ملف openapi من routes المعرفة والتي يضاف عليها annotation معينة.

أنا أنصح ﻷي backend API أن يكون موثقاً بالـOpenAPI لما فيه من مرونة ولجمال واجهة documentation التي يولدها.

انا فهمت ما تقصد .. لكن لحظة .. هنا swagger تعتبر باك اند وليست فرونت اند .. مهمة الفرونت اند فقط هى ان يقوم ب عمل ال endpoints مثلا ان يعمل له فيتش مثلا .. اما غير ذلك فهى مهمة الباك اند صحيح ؟؟

بتاريخ الآن قال Ahmed Sawy:

انا فهمت ما تقصد .. لكن لحظة .. هنا swagger تعتبر باك اند وليست فرونت اند .. مهمة الفرونت اند فقط هى ان يقوم ب عمل ال endpoints مثلا ان يعمل له فيتش مثلا .. اما غير ذلك فهى مهمة الباك اند صحيح ؟؟

أجل مهمة frontend أن يقوم بعمل fetch للـendpoints