تولید مستندات API

مناسب برای REST API، GraphQL و Microserviceها.

اگر API (رابط برنامه‌نویسی نرم‌افزار) نوشته‌اید و مستندات مناسبی ندارید، این پرامپت مستندات کامل و حرفه‌ای برای آن تولید می‌کند. این ابزار ساختار API شما را تحلیل کرده و یک راهنمای قابل استفاده برای توسعه‌دهندگان ایجاد می‌کند. قبل از اجرا، مقادیر زیر را جایگزین کنید: [API_CODE] کد API یا بخش‌های مربوط به Endpointها (مسیرهای دسترسی API) [FRAMEWORK] فریم‌ورک یا تکنولوژی مورد استفاده (مانند Django REST Framework، FastAPI یا Express) [AUTH_METHOD] روش احراز هویت API (مانند Token، JWT یا API Key) خروجی شامل: - معرفی کلی API - Endpointها (مسیرهای درخواست API) - پارامترهای ورودی - Headerهای موردنیاز - نمونه Request (درخواست ارسال‌شده) - نمونه Response (پاسخ دریافت‌شده) - کدهای خطا و توضیحات آن‌ها - راهنمای Authentication (احراز هویت) - مثال‌های استفاده خواهد بود. کلمات انگلیسی داخل براکت [ ] متغیرهایی هستند که باید قبل از اجرا با اطلاعات موردنظر خود جایگزین شوند.