SwagDoc

Swagdoc

Swagdoc هي مكتبة Delphi لإنشاء ملف Swagger.json لـ Swagger Spec Version 2.0. قم بإنشاء واجهة برمجة تطبيقات REST للوثائق العامة باستخدام Swagger 2.0 للغة Delphi. مسؤولية Swagdoc الوحيدة هي إنشاء ملف Swagger.json. ملف Swagger.json مسؤول عن احتواء جميع الوثائق الخاصة بأو طرقة الراحة الخاصة بك. يجب إرفاق هذا الملف بملفات Swagger UI (واجهة المستخدم).

Swagger (Open API) - الإصدار 2.0

يتبع Swagdoc المواصفات 2.0 لأنه أكثر شعبية في السوق وأيضًا لأنه يعتبر نسخة أكثر استقرارًا للوجود أطول. لا يدعم Swagdoc بعد إصدار Swagger 3.0 ، ولكن بناءً على الطلب والمساهمات في المشروع ، قد يتطور لدعم SPEC 3.0.

يتمثل الشرط الأساسي الرئيسي للعمل مع Swagdoc في معرفة مواصفات Swagger 2.0 التي يمكن عرضها في الرابط أدناه.

https://github.com/oai/openapi-specification/blob/master/versions/2.0.md

https://swagger.io/docs/specification/2-0/basic-tructure/

عند إنشاء وثائق Swagger ل API REST ، يمكنك إنتاج صفحة مثل المثال التالي.

https://app.swaggerhub.com/apis-docs/swagdoc/sample-api/v1

مخطط JSON

https://github.com/oai/openapi-specification/blob/master/versions/2.0.md#schemaObject

http://json-schema.org

خطب Swagdoc

https://www.youtube.com/watch؟v=9U3HP3B5UT0 (PT-BR)

https://www.youtube.com/watch؟v=phgmqad8o6c (PT-BR)

المراجع والبرامج التعليمية

https://swagger.io/swagger/media/blog/wp-content/uploads/2017/02/documenting-an-existing-api-with-swagger-2.pdf

https://idratherbewriting.com/learnapidoc/pubapis_swagger_intro.html

أدوات التباهي

• Swagger: https://swagger.io

• محرر Swagger: https://editor.swagger.io

• Swagger Hub: https://swagger.io/tools/swaggerhub

• عينة Swagger الكلاسيكية: http://petstore.swagger.io

• الأدوات والتكامل: https://swagger.io/tools/open-source/open-source-integrations

ملفات توزيع واجهة المستخدم Swagger

لكي تنتج صفحة تحتوي على وثائق Swagger ، تحتاج إلى ملفات توزيع واجهة المستخدم Swagger.

هذه الملفات التي يمكنك العثور عليها في مستودع GitHub Swagger-API / Swagger-UI.

https://github.com/swagger-api/swagger-ui/tree/master/dist

تحتاج أولاً إلى تنزيل ملفات واجهة المستخدم Swagger وإنشاء ملف Swagger.json. تحتاج بعد ذلك إلى تغيير ملف index.html للإشارة إلى المسار النسبي للموقع حيث يوجد ملف Swagger.json على خادم الويب الخاص بك يستضيف ملفات واجهة المستخدم Swagger.

انظر مثال أدناه.