برای شروع دولوپ بهتره اول api ها طراحی بشن و بعد کدنویسی شروع بشه که در مواقعی که طراح api و توسعه دهنده ی آن فرق داره، بسیار کاربردیه.
دو نرم افزار postman و stoplight برای اینکار وجود دارن که در این مقاله در مورد stoplight صحبت میشه. در این نرم افزار تحت وب که استفاده ازش بسیار راحته، rest api ها تعریف میشن.
بعد از ثبت نام یه workspace میسازه که قابلیت اعطای دسترسی به اعضای تیم با تعیین سطح محدودیت را داره.
میتونید api ها را دسته بندی کنید که برای هر دسته یک فایل json خروجی میده که این فایل json را swagger ui میشناسه. البته تعریف api ها در این نرم افزاز کاملا ویژوال هست و اصلا نیاز ب کدنویسی نداره.
در stoplight نوع هر api تعریف میشه، پارامتر ها و ریسپانس ها از هر نوعی مشخص میشن. برای هر api تگ تعریف میشه. مدل میشه تعریف کرد و هر مدل را در تعریف api های مختلف استفاده کرد.
از openapi پشتیبانی میکنه، یعنی اگر هنگام generate کد های فرانت با openapi به خطایی بربخوره، هنگام تعریف api این خطا در نرم افزار مشخصه و لازم نیس توسعه دهنده ی فرانت این خطا را اعلام کنه پس سرعت کار بیشتر میشه.
مدل های مختلف security را پشتیبانی میکنه، مثلا من از تایپ های مختلف oauth استفاده کردم و بسیار ساده بود.
تقریبا تمام فیچر هایی ک swagger پشتیبانی میکنه را در این نرم افزار بشکل ویژوال میبینید.
با source control هایی مثل گیت لب یکپارچه شده، پس شما میتونین نسخ api هایی که طراحی کردید را نگهداری کنید.
میتونید یه روال deploy هم براش درنظر بگیرید که هر زمان api های طراحی شده، تغییری کرد و روی گیت push شد، از طریق یک docker image از swagger ui روی سرور توسعه قابل نمایش باشه. پس با هر تغییری در طراحی api ها، swagger ui نسخه ی جدید api ها را نمایش میده.
البته بگم تحریمیم و از شکن استفاده کنید!
آدرسش هم هست: stoplight.io
