سوالات مصاحبه طراحی API: REST و فراتر از آن

این را تصور کنید: شما در یک مصاحبه طراحی سیستم هستید و مصاحبه کننده از شما می خواهد که یک API برای یک پلتفرم رسانه اجتماعی طراحی کنید. ذهن شما از طریق تصمیم گیری های بی شماری می چرخد ​​- چگونه روابط کاربر را مدل می کنید؟ صفحه بندی برای اسکرول بی نهایت چطور؟ چگونه با نسخه های مختلف اپلیکیشن موبایل برخورد می کنید؟

سؤالات طراحی API از رایج ترین سؤالات در مصاحبه های فنی هستند زیرا نشان می دهند که چگونه در مورد مقیاس پذیری، تجربه کاربر و معماری سیستم فکر می کنید. برخلاف سؤالات الگوریتم خالص، طراحی API توانایی شما را در ساختن سیستم هایی که کاربران واقعی به آن وابسته هستند، نشان می دهد. چه در حال طراحی API فید اینستاگرام یا نقاط پایانی پردازش پرداخت Stripe باشید، همان اصول اساسی اعمال می شود.

در این مقاله، مفاهیم کلیدی را که مصاحبه‌کنندگان هنگام ارزیابی مهارت‌های طراحی API، تمرکز بر مدل‌سازی منابع، استراتژی‌های نسخه‌سازی، رویکردهای صفحه‌بندی، و الگوهای مدیریت خطا به دنبال آن هستند، بررسی می‌کنیم. در پایان، چارچوبی برای پاسخگویی به هر سؤال طراحی API با اطمینان خواهید داشت.

مفاهیم اصلی: بلوک های ساختمان API های بزرگ

مدل سازی منابع: تفکر در منابع، نه کارکردها

اساس طراحی REST API در شناسایی و مدل سازی صحیح منابع نهفته است. یک منبع نشان دهنده هر اطلاعاتی است که می تواند از طریق یک URI نامگذاری و آدرس دهی شود. منابع را به عنوان اسامی در سیستم خود در نظر بگیرید، در حالی که روش های HTTP افعال را نشان می دهد.

یک پلتفرم وبلاگ نویسی را در نظر بگیرید. منابع اصلی شما ممکن است شامل موارد زیر باشد:

• کاربران: به نمایندگی از نویسندگان و خوانندگان
• پست ها: ورودی های وبلاگ فردی با محتوا و ابرداده
• نظرات: پاسخ کاربران به پست ها
• دسته بندی ها: راه های سازماندهی و فیلتر کردن محتوا
• اشتراک ها: روابط بین کاربران و محتوا

هر منبع باید ساختار شفاف و سلسله مراتبی داشته باشد که روابط دنیای واقعی را منعکس کند. کاربران پست ها را ایجاد می کنند، پست ها متعلق به دسته ها هستند و نظرات به پست ها تعلق دارند. این سلسله مراتب به ساختار URL شما تبدیل می شود: /users/123/posts برای پست های یک کاربر، یا /posts/456/comments برای نظرات یک پست

بینش کلیدی این است که مدل سازی منابع خوب باعث می شود API شما بصری باشد. توسعه دهندگان باید بتوانند URL های نقطه پایانی را بر اساس روابطی که از دامنه شما درک می کنند، حدس بزنند.

نسخه API: مدیریت تغییرات در طول زمان

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

چندین استراتژی نسخه‌سازی وجود دارد که هر کدام دارای معاوضه‌های متفاوتی هستند:

نسخه URL نسخه را مستقیماً در مسیر قرار می دهد: /v1/users در مقابل /v2/users. این رویکرد صریح و قابل درک است و آن را برای APIهای عمومی محبوب می کند. می‌توانید نحوه مسیریابی نسخه‌های مختلف به لایه‌های خدمات مختلف را با استفاده از InfraSketch تجسم کنید، که به روشن شدن مفاهیم معماری کمک می‌کند.

نسخه هدر از هدرهای سفارشی مانند استفاده می کند API-Version: 2.0. این نشانی‌های وب را تمیز نگه می‌دارد و اجازه می‌دهد تا کنترل نسخه دقیق‌تری در هر نقطه پایانی انجام شود. با این حال، برای توسعه دهندگان کمتر قابل مشاهده است و به طور موثر کش کردن آن سخت تر است.

مذاکره محتوا از هدر Accept استفاده می کند: Accept: application/vnd.api.v2+json. این از استانداردهای HTTP پیروی می کند اما با افزودن انواع و نسخه های مختلف محتوا می تواند پیچیده شود.

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

صفحه بندی: مدیریت مجموعه داده های بزرگ

APIهای دنیای واقعی مجموعه داده های عظیمی را ارائه می دهند. اینستاگرام میلیاردها عکس دارد، GitHub میلیون‌ها مخزن دارد و API شما باید مجموعه‌های بزرگ را به طور کارآمد مدیریت کند.

صفحه بندی مبتنی بر افست استفاده می کند ?limit=20&offset=100 پارامترها این شهودی است و امکان پرش به صفحات دلخواه را فراهم می‌کند، اما عملکرد با جابجایی‌های بزرگ کاهش می‌یابد زیرا پایگاه‌های داده باید از تعداد رکوردهای فزاینده خودداری کنند.

صفحه‌بندی مبتنی بر مکان‌نما از نشانه های مات استفاده می کند که موقعیت ها را در مجموعه داده نشان می دهد: ?limit=20&cursor=eyJpZCI6MTIzfQ. این رویکرد بدون توجه به اندازه مجموعه داده عملکرد ثابتی را ارائه می دهد و به روز رسانی های بلادرنگ را به خوبی مدیریت می کند، اما شما توانایی پرش به صفحات دلخواه را از دست می دهید.

صفحه بندی مبتنی بر زمان برای داده های زمانی به خوبی کار می کند: ?limit=20&since=2023-12-01T10:00:00Z. فیدهای رسانه های اجتماعی اغلب از این الگو استفاده می کنند زیرا کاربران به محتوای اخیر اهمیت می دهند نه مرور تاریخی.

ملاحظات معماری این است که چگونه سرورهای API شما با پایگاه‌های داده و حافظه پنهان برای حفظ وضعیت صفحه‌بندی هماهنگ می‌شوند و در عین حال نتایج ثابتی را در سیستم‌های توزیع شده ارائه می‌دهند.

مدیریت خطا: ارتباط با مشکلات به وضوح

مدیریت خطای قوی API های حرفه ای را از آماتورها جدا می کند. خطاها فقط مربوط به کدهای وضعیت HTTP نیستند – آنها در مورد ارائه اطلاعات قابل اجرا هستند که به توسعه دهندگان کمک می کند مشکلات را سریع حل کنند.

معماری خطای شما باید بین انواع مختلف خطا تمایز قائل شود:

خطاهای مشتری (4xx) مشکلات مربوط به خود درخواست را نشان می دهد. یک 400 Bad Request باید شامل پیام های اعتبارسنجی خاصی باشد، در حالی که 401 Unauthorized باید کاربران را به سمت احراز هویت راهنمایی کند. محدود کردن نرخ مستحق توجه ویژه است – 429 درخواست‌های بیش از حد باید شامل اطلاعات زمان‌بندی مجدد باشد.

خطاهای سرور (5xx) مشکلات زیرساختی را نشان می دهد. این خطاها باید به طور گسترده برای سیستم های نظارتی شما ثبت شوند و در عین حال حداقل اطلاعات را به مشتریان به دلایل امنیتی ارائه می دهند.

خطاهای منطق کسب و کار نیاز به رسیدگی سفارشی دارد. وقتی پرداختی انجام نمی‌شود یا موجودی تمام می‌شود، به کدهای خطا و پیام‌های خاص دامنه نیاز دارید که برنامه‌های مشتری بتوانند از طریق برنامه‌نویسی آن‌ها را مدیریت کنند.

پاسخ‌های خطا باید از ساختاری ثابت در کل API شما پیروی کنند، که مدیریت خطای سمت مشتری را قابل پیش‌بینی و کاهش پیچیدگی یکپارچه‌سازی می‌کند.

چگونه کار می کند: درخواست جریان و تعاملات سیستم

درک طراحی API مستلزم دیدن چگونگی جریان درخواست ها از طریق معماری سیستم شما است. بیایید یک درخواست API معمولی را از مشتری به پایگاه داده و برگشت دنبال کنیم.

خط لوله پردازش درخواست

هنگامی که یک کلاینت درخواست API می کند، وارد یک خط لوله پردازش با چندین مرحله می شود. هر مرحله دارای مسئولیت های خاصی است و می تواند به طور مستقل مقیاس شود.

متعادل کننده های بار درخواست های دریافتی را دریافت کرده و آنها را در چندین نمونه سرور API توزیع کنید. آنها بررسی های سلامتی را انجام می دهند و می توانند نسخه های API مختلف را به خوشه های سرور مختلف هدایت کنند.

دروازه API نگرانی های مقطعی مانند احراز هویت، محدود کردن نرخ، ثبت درخواست و تبدیل پاسخ را مدیریت می کند. اینجاست که کلیدهای API تایید می‌شوند و سهمیه‌های استفاده اعمال می‌شوند.

سرورهای کاربردی منطق کسب و کار و مدل سازی منابع شما را شامل می شود. آنها درخواست ها را تجزیه می کنند، داده ها را تأیید می کنند، قوانین تجاری را اعمال می کنند و با خدمات پایین دستی هماهنگ می کنند.

لایه داده شامل پایگاه داده ها، کش ها و سرویس های خارجی است. APIهای مدرن معمولاً قبل از تشکیل پاسخ نیاز به جمع آوری داده ها از چندین منبع دارند.

ابزارهایی مانند InfraSketch به شما کمک می کنند تا این مراحل خط لوله را تجسم کنید و نحوه تعامل اجزا را درک کنید، به ویژه هنگام طراحی برای دسترسی بالا و مقیاس افقی.

وضوح منابع و تجمیع داده ها

نقاط پایانی API پیچیده اغلب به داده هایی از چندین منبع نیاز دارند. نقطه پایانی مانند را در نظر بگیرید /users/123/dashboard که نمای شخصی‌شده را با ترکیب نمایه کاربر، فعالیت‌های اخیر، توصیه‌ها و اعلان‌ها برمی‌گرداند.

سرور API باید چندین پرس و جو پایگاه داده، جستجوهای حافظه پنهان و تماس های بالقوه خدمات خارجی را هماهنگ کند. این هماهنگی می تواند به صورت سریال (آهسته تر اما ساده تر) یا موازی (سریع تر اما پیچیده تر رسیدگی به خطا) اتفاق بیفتد.

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

مجمع پاسخگویی و قالب بندی

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

قالب بندی پاسخ اغلب شامل مبادله بین اندازه بار و پیچیدگی مشتری است. گنجاندن منابع مرتبط به صورت درون خطی (مانند نظرات پست) سفرهای رفت و برگشت را کاهش می دهد اما استفاده از پهنای باند را افزایش می دهد. در عوض ارائه پیوندهای منبع به درخواست های بیشتری نیاز دارد اما ذخیره سازی بهتری را امکان پذیر می کند.

ملاحظات طراحی: معاوضه ها و استراتژی های مقیاس بندی

عملکرد در مقابل انعطاف پذیری

طراحی API به طور مداوم عملکرد را در مقابل انعطاف پذیری متعادل می کند. نقاط پایانی بسیار خاص مانند /users/123/recent-posts-with-comments عملکرد خوبی دارند زیرا برای موارد استفاده خاص بهینه شده اند. با این حال، آنها سربار تعمیر و نگهداری ایجاد می کنند و به خوبی با نیازهای مشتری در حال تغییر سازگار نیستند.

نقاط پایانی عمومی مانند /posts?user=123&include=comments انعطاف پذیری را فراهم می کند اما به استراتژی های پردازش پرس و جو و حافظه پنهان بیشتری نیاز دارد. معماری باید از انتخاب میدان پویا، فیلتر کردن و مرتب‌سازی پشتیبانی کند و عملکرد قابل قبولی را حفظ کند.

GraphQL یک رویکرد را برای این مبادله نشان می دهد و به مشتریان اجازه می دهد دقیقاً به چه داده هایی نیاز دارند، مشخص کنند. با این حال، پیچیدگی های جدیدی را در مورد بهینه سازی پرس و جو و امنیت معرفی می کند.

سازگاری در مقابل در دسترس بودن

معماری های API توزیع شده باید محدودیت های قضیه CAP را مدیریت کنند. هنگامی که داده های کاربر در چندین پایگاه داده یا مناطق جغرافیایی پخش می شوند، باید بین ثبات فوری و در دسترس بودن بالا یکی را انتخاب کنید.

در نهایت سیستم های سازگار می توانند داده های قدیمی را ارائه دهند اما در طول پارتیشن های شبکه در دسترس باقی می مانند. سیستم های کاملاً سازگار همیشه داده های فعلی را ارائه می دهند اما ممکن است در هنگام خرابی در دسترس نباشند.

طراحی API شما باید این مبادلات را از طریق مستندات و به طور بالقوه از طریق پارامترهای پرس و جو که به مشتریان اجازه می دهد سطح سازگاری خود را برای موارد استفاده مختلف انتخاب کنند، آشکار کند.

امنیت و کنترل دسترسی

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

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

کلیدهای API، توکن‌های OAuth و اعتبارنامه‌های JWT هر کدام موارد استفاده متفاوتی را ارائه می‌کنند و مفاهیم معماری مجزایی برای اعتبارسنجی و لغو توکن دارند.

خوراکی های کلیدی

طراحی موفق API در مصاحبه ها توانایی شما را در تفکر سیستماتیک در مورد سیستم های پیچیده توزیع شده نشان می دهد. روی این اصول اصلی تمرکز کنید:

مدل سازی منابع باید مفاهیم و روابط دنیای واقعی را منعکس کند. با اسم ها (منابع) شروع کنید و از افعال HTTP برای اعمال استفاده کنید. ساختار URL شما باید بصری و سلسله مراتبی باشد.

استراتژی نسخه سازی به اکوسیستم مشتری و فرکانس تغییر بستگی دارد. نسخه‌سازی URL برای APIهای عمومی به خوبی کار می‌کند، در حالی که نسخه‌سازی هدر برای APIهای داخلی با کلاینت‌های پیچیده مناسب است.

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

رسیدگی به خطا باید جامع و قابل اجرا باشد. بین خطاهای کلاینت، خطاهای سرور و خطاهای منطق تجاری تمایز قائل شوید. اطلاعات کافی برای اشکال زدایی بدون افشای آسیب پذیری های امنیتی ارائه دهید.

معماری سیستم باید نگرانی ها را کاملاً از هم تفکیک کرد. دروازه‌های API نگرانی‌های متقاطع را مدیریت می‌کنند، سرورهای برنامه منطق تجاری را پیاده‌سازی می‌کنند، و لایه‌های داده، ماندگاری و حافظه پنهان را مدیریت می‌کنند.

هنگام بحث در مورد این مفاهیم در مصاحبه، همیشه مفاهیم مقیاس بندی را در نظر بگیرید. طراحی شما چگونه 10 برابر ترافیک بیشتر را مدیریت می کند؟ 100 برابر داده بیشتر چطور؟ چگونه ثبات را در بین مناطق جغرافیایی حفظ می کنید؟

به یاد داشته باشید که طراحی API در نهایت ایجاد رابط هایی است که توسعه دهندگان دوست دارند از آن استفاده کنند. اگر تجربه توسعه دهندگان ضعیف باشد، بهترین معماری فنی معنایی ندارد.

خودتان آن را امتحان کنید

بهترین راه برای تسلط بر طراحی API از طریق تمرین است. سعی کنید API هایی را برای حوزه های مختلف طراحی کنید: پلتفرم های تجارت الکترونیک، سیستم های پیام رسانی، خدمات ذخیره سازی فایل یا شبکه های اجتماعی. هر دامنه دارای چالش های منحصر به فردی است که درک شما را عمیق تر می کند.

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

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

نمایش بصری به شما کمک می کند شکاف های معماری را شناسایی کنید و تصمیمات طراحی خود را به وضوح در طول مصاحبه توضیح دهید. طراحی عالی API فقط پیروی از اصول REST نیست، بلکه در مورد ساختن سیستم هایی است که به زیبایی مقیاس شوند و تجربیات توسعه دهندگان عالی را ارائه دهند.