مستندات API

مشاهده API ها با Swagger

با استفاده از Swagger UI می‌توانید به راحتی تمامی API های موجود در سیستم را مشاهده کنید.

دسترسی به Swagger

برای مشاهده مستندات API از طریق Swagger، کافیست به آدرس زیر مراجعه کنید:

http://127.0.0.1:8000/api/documentation

امکانات Swagger

با استفاده از Swagger شما می‌توانید:

• تمامی API های موجود در سیستم را مشاهده کنید
• جزئیات هر API شامل پارامترها و مدل‌های داده را ببینید
• نمونه درخواست‌ها و پاسخ‌ها را مشاهده کنید

احراز هویت

برای دسترسی به API های نیازمند احراز هویت، از بخش "احراز هویت" در Swagger استفاده کنید.

برای تمدید توکن دسترسی می‌توانید از API زیر استفاده کنید:

POST http://127.0.0.1:8000/api/احراز هویت/refreshToken

سرور به صورت پیش‌فرض روی پورت 8000 اجرا می‌شود و می‌توانید به آدرس http://127.0.0.1:8000/api/documentation دسترسی داشته باشید.