بهترین روش برای ایجاد دایکیومنت برای laravel api
سلام دوستان
برای بکند که با لاراول نوشته میشه، بهترین روش برای اینکه داکیومنت رو بهم نشون بده چیه؟؟
از چه ابزاری استفاده بکنیم؟؟؟
مرسی
پاسخها
10
@mortezasb87
swagger یکی از ابزار های خوب و رایگان میتونید ازش استفاده کنید
https://swagger.io
بهترین حالت اینه که شما داکیومنت خوبی برای کدتون بنویسید و از نام هایی برای اسم متدها استفاده کنید که کاملا مشخص باشند
گفتگوهای مرتبط
شاید پاسخ شما همینجا باشد
منظورم اینکه من که فرانت کارم و قراره با api کار کنم
باید یه داکیومنتی باشه که من بدونم از چه متودی استفاده کنم و چه پارامتر هایی بفرستم
واسه همچین حالتی باید از چی استفاده کرد؟
معمولا کسی که API رو مینویسه، موظفه یه مستندات حداقلی هم ازش ارائه کنه.. تا بشه ازش استفاده کرد
در غیر این صورت شما باید با بررسی کدهایی که این شخص نوشته ، خودتون سر از کار در بیارید
باید شامل یه سری اطلاعات حداقلی باشه مثل
- endpoint (همون Route که شما باید درخواست رو بهش ارسال کنید)
- پارامتر های بدنه درخواست (اطلاعاتی که شما در ارسال به endpoint ضمیمه میکنید)
- پاسخ برگشتی (اطلاعاتی که از سرور برمیگرده; شامل نوع داده )
برای مثال تصویر زیر مربوط به مستندات وبسرویس ip-api هست:
اینارو میدونم ولی بکندکار چجوری این داکیومنت رو به من بده؟
ابزاری وجود داره که کار رو راحت کنه؟
بک اند کار باید لیستی از این موارد رو در اختیار شما بذاره.. حالا میخواد فایل HTML باشه.. pdf باشه هر چی ....
حتی میتونه از ابزار هایی هم برای ایجاد این مستندات استفاده کنه:
مهم اینه که این موارد رو در اختیار شما قرار بده
چنانچه همچین ابزاری هم موجود باشه تنها تا حد خیلی کمی اطلاعات رو برای شما generate میکنه..
در واقع بکاند کاری که داره API رو مینویسه.. باید در متدی رو که میخواد بنویشه اول کامنتهای اونو بنویسه و توضیحاتی هم در موردش بده... این جوری در پایان کار هم خیلی راحت همون اطلاعات رو با کمب تغییر تبدیل به میتندات میکنه و به فرانت کار تحویل میده..