انتقل إلى المحتوى
أمين أبوزيد
درس مخطط لهJNR-021-L02

توليد التوثيق من Spring (springdoc)

  • الدرس 2 من 5
  • Junior
في هذا الدرس 4 موضوعات

هذا الدرس مخطط له. يعرض المخطط أدناه الموضوعات التي سيغطيها، ولم يُنشر الدرس الكامل بعد.

نص الدروس والتمارين باللغة الإنجليزية، بينما تبقى واجهة الموقع وعناوين الدروس بالعربية.

في هذا الدرس

get a spec and Swagger UI from existing code.

الموضوعات المخطط لها

  • springdoc-openapi reads your controllers and DTOs and builds the spec at run time. Verify the artifact name and version for your Spring Boot version before recording.
  • The spec is served as JSON (commonly at /v3/api-docs).
  • Swagger UI is a web page (commonly /swagger-ui.html) where you read and try endpoints.
  • Annotations such as @Operation and @Schema add detail where the code alone is not enough.
  • In production, decide whether the docs endpoints should be public.
تفاصيل المخطط المبدئي

عرض عملي

add the starter dependency, run the app, open the UI, and call GET /products with "Try it out".

اختبر فهمك

What is Swagger UI for?

أظهر الإجابة

Reading and trying the API in a browser.

التطبيق

طبّق هذا الدرس بمختبر الوحدة وتمارينها واختبارها.

المختبر والتمارين الاختبار

تعليم الدرس كمكتمل اختياري ويمكنك التراجع عنه في أي وقت. يبقى تقدمك محفوظًا في هذا المتصفح.

اكتب للبحث في المستويات والمراحل والوحدات والدروس.