راکت

معرفی ابزار برای مستندسازی api

2 پاسخ

سلام دوستان
برای نوشتن مستندات api توسط تیم backend که تیم frontend از اون مستندات استفاده کنن چه ابزاری رو پیشنهاد میکنید
من از پستمن استفاده میکنم و بعد هر تغییرات فایل جدید رو برای تیم فرانت میفرستم یا با استفاده از قابلیت sync خود پستمن فرانت آخرین ورژن api رو میبینه. اما مشکلی که دارم اینه که ممکنه توی api توی هدر و یا یکی از فیلدهای body تغییر[ات] جزیی داشته باشیم که برای هر تغییر backend کار باید بصورت حضوری به frontendکار تغییرات رو توضیح بده. برای این موضوع چه راه حلی پیشنهاد میدین که وابستگی به بکند کمتر بشه ؟ و frontend کار از تغییرات به مثلا بصورت changelist مطلع بشه
این مشکل بخاطر این هست که تو بعضی از شرکت ها ساعت و روزهای کاری بکند کار و فرانت کار باهم فرق داره و ممکن هست بهم دسترسی نداشته باشن.
میخواستم بدونم در رابطه با این موضوع تجربه ای دارین؟

ثبت پرسش جدید

پاسخ‌ها

2
میلاد قدیریان
میلاد قدیریان
@miladia

تخصص: برنامه نویس بک اِند | لاراول

از swagger استفاده کنید

سینا شاه‌اویسی
سینا شاه‌اویسی
@sinashahoveisi

تخصص: برنامه نویس

سلام میتونید از document Generator استفاده کنید مثل swagger و اگه از لاراول استفاده میکنید این پکیج خیلی خوبه ما خودمون ازش استفاده میکنیم.

شاید پاسخ شما همین‌جا باشد

برای ارسال پاسخ لازم است وارد شده یا ثبت‌نام کنید

ورود یا ثبت‌نام