نکاتی برای ابزارسازی با استفاده از OpenAPI

دلیل اصلی تبدیل شدن من به توسعه، ساختن چیزهای جالب بود. اما مانند هر شغلی، به سرعت متوجه می شوید که کارهای تکراری بخش بزرگی از زندگی شما هستند. خوشبختانه، به‌عنوان توسعه‌دهندگان، ما در موقعیت منحصربه‌فردی برای ایجاد ابزارهایی هستیم که این وظایف تکراری را کاهش می‌دهند یا به طور کامل حذف می‌کنند.

یکی از وظایف ما در Nord Security ایجاد SDK های مشتری برای APIها و به روز نگه داشتن آنهاست.

مشکل SDK های مشتری چیست؟

فرض کنید یک API گیمر ساده می‌سازیم که به گیمرها اجازه می‌دهد ثبت نام کنند:

<code>POST /api/v1/gamers</code>

سپس یک کلاینت php-gamer-sdk ایجاد می کنیم تا پروژه های دیگر بتوانند از آن استفاده کنند. پس از مدتی بحث با تیم دیگر، متوجه می شوید که ما به یک گلنگ sdk نیز نیاز داریم. آسان است، شما یک go-gamer-sdk برای استفاده همه ایجاد می کنید.

جایگزینی برای به روز رسانی دستی SDK

به جای ایجاد دستی SDK ها، می توانیم از OpenAPI استفاده کنیم. OpenAPI استانداردی برای توصیف API ها با استفاده از فایل های ساده قدیمی YAML است. این استاندارد (که قبلاً به نام Swagger شناخته می شد) از قالبی استفاده می کند که هم توسط انسان و هم توسط ماشین قابل خواندن باشد.

استفاده از مراجع

حتی اگر فایل مشخصات ما یک نقطه پایانی ساده را توصیف می کند، در حال حاضر به نظر می رسد درهم و برهم است – خواندن آن بسیار دشوار است. با این حال، یک راه آسان در اطراف آن وجود دارد – ارجاعات.

ایده پشت یک مرجع ساده است – می توانید چیزی را در جای دیگری از مشخصات تعریف کنید و به آن اشاره کنید. اساساً مانند تعریف یک متغیر و استفاده از آن بعداً است.

بنابراین ابتدا درخواست و پاسخ خود را به عنوان اجزای قابل استفاده مجدد تعریف کنید.