یه پست (سوال) لینکدین از Sahar Farahzad در مورد DRF. جالبه + چندتا از نظرات پست هم توی کامنت ها میزام
لینک پست:
https://www.linkedin.com/posts/sahar-farahzad-7b7559ba_django-rest-swagger-220-activity-7030204542608637952-IcHA?utm_source=share&utm_medium=member_desktop
سلام دوستان.
دوستان جنگو کار یه سوال ازتون دارم:
کسی میدونه چطور میشه داکیومنت swagger و برای جنگو بهینه کرد؟
من یه سری راهکار پیدا کردم اما بازم خوب نیست. مثلا اگه توی ویو کامنت بذاریم
“””
list:
my title
my description
“””
این میاد برای Get عنوان و توضیحات میذاره. نکته اش اینه که حتما یه خط بینش فاصله باشه تا تشخیص بده اولیه عنوان و دومیه توضیحات هست. اما خب فرض کن همینجا برای create و update و partial_updat و … هم بذاری. اونوقت تو api اصلا چیز قشنگی نشون نمیده و همه یه خط درمیون فاصله هست. خیلی بد میشه.
سوال دومم اینه که چطوری میشه example ها رو درست کرد؟
دو نوع example داریم:
1. Parameters
2. Responses
یه سری جاها به جای اینکه توی example آبجکت و نشون بده، یک استرینگ فقط برای id داره در حالی که توی api آبجکت هستش.
یه راهکار پیدا کردم که جواب نداد گویا واسه ورژن های قدیمی هست. مثلا:
“””
parameters:
-name: user
type: string
“””
اینجا برعکس انجام دادم. انتظار داشتم user که آبجکت هست تبدیل به id که استرینگ هست بشه.
چندین روزه دارم میگردم. اگه کمک کنید ممنون میشم.
کسی راهکار بهتر داره؟
لینک هایی که خوندم اینا مهمترینهاش بودن:
https://lnkd.in/e7YkdtNK
https://lnkd.in/eeuSRGNM
https://lnkd.in/ek5ZD29S
این باید چیز خوبی باشه اما نتونستم خوب بفهممش:
https://lnkd.in/ej6WMv4i