همانطور که برنامه های کاربردی وب پیچیده تر و به هم پیوسته تر می شوند، نیاز به ارتباطات استاندارد بین سیستم ها ضروری شده است. اینجاست که رابط های برنامه نویسی کاربردی (API) وارد عمل می شوند. APIها به سیستم‌های نرم‌افزاری مختلف اجازه می‌دهند با یکدیگر ارتباط برقرار کنند و تبادل اطلاعات و عملکرد یکپارچه را ممکن می‌سازند.
یکی از جنبه های مهم API ها استفاده آن ها از کدهای وضعیت است. کدهای وضعیت API کدهای پاسخ HTTP استاندارد هستند که اطلاعاتی را در مورد نتیجه درخواست API ارائه می دهند. در این مقاله، انواع مختلف کدهای وضعیت API و معنای آنها برای توسعه دهندگان را بررسی خواهیم کرد.
کدهای وضعیت HTTP
کدهای وضعیت API بر اساس کدهای وضعیت HTTP هستند که اعداد سه رقمی هستند که توسط سرور در پاسخ به درخواست مشتری بازگردانده می شوند. کدهای وضعیت HTTP به پنج کلاس تقسیم می شوند که هر کدام محدوده کدهای خاص خود را دارند:
- 1xx: اطلاعاتی
- 2xx: موفقیت
- 3xx: تغییر مسیر
- 4xx: خطاهای مشتری
- 5xx: خطاهای سرور
هر یک از این کلاس ها با نوع خاصی از نتیجه مطابقت دارد. به عنوان مثال، یک کد 2xx نشان می دهد که یک درخواست با موفقیت انجام شده است، در حالی که یک کد 4xx نشان می دهد که مشتری خطا کرده است.
کدهای وضعیت API
کدهای وضعیت API زیرمجموعه ای از کدهای وضعیت HTTP هستند که به طور خاص در ارتباطات API استفاده می شوند. در حالی که بسیاری از کدهای وضعیت HTTP وجود دارد، تنها زیر مجموعه ای از آنها معمولاً در ارتباطات API استفاده می شوند. رایج ترین کدهای وضعیت API مورد استفاده عبارتند از:
- 200 OK: درخواست موفقیت آمیز بود و پاسخ حاوی داده های درخواستی است.
- 201 Created: درخواست با موفقیت انجام شد و یک منبع جدید ایجاد شد.
- 204 بدون محتوا: درخواست موفقیت آمیز بود، اما هیچ داده ای برای بازگشت وجود ندارد.
- 400 درخواست بد: درخواست بد شکل یا نامعتبر بود.
- 401 غیر مجاز: درخواست نیاز به احراز هویت دارد، اما کاربر اعتبارنامه معتبری ارائه نکرده است.
- 403 ممنوع: کاربر اجازه دسترسی به منبع درخواستی را ندارد.
- 404 یافت نشد: منبع درخواستی یافت نشد.
- 500 خطای داخلی سرور: سرور هنگام پردازش درخواست با خطا مواجه شد.
بیایید نگاهی دقیق تر به برخی از این کدها بیندازیم.
200 باشه
کد 200 OK رایج ترین کد وضعیت API است. این نشان می دهد که درخواست موفقیت آمیز بوده است و پاسخ حاوی داده های درخواستی است. به عنوان مثال، اگر یک کلاینت اطلاعاتی در مورد یک کاربر درخواست کند و سرور با موفقیت آن اطلاعات را برگرداند، یک کد 200 OK را برمی گرداند.
400 درخواست بد
کد 400 Bad Request زمانی بازگردانده می شود که مشتری درخواستی را ارسال کند که شکل نادرست یا نامعتبر باشد. این ممکن است به دلیل گم شدن یا نادرست بودن پارامترها یا سایر مشکلات مربوط به درخواست باشد. به عنوان مثال، اگر مشتری درخواستی برای ایجاد یک کاربر جدید ارسال کند اما فیلد مورد نیاز مانند آدرس ایمیل را شامل نشود، سرور یک کد 400 Bad Request را برمی گرداند.
401 غیر مجاز
کد 401 Unauthorized زمانی بازگردانده می شود که مشتری تلاش می کند به یک منبع محافظت شده دسترسی پیدا کند بدون اینکه اعتبار احراز هویت معتبر ارائه کند. به عنوان مثال، اگر یک کلاینت بدون ارائه یک نام کاربری و رمز عبور معتبر سعی کند به اطلاعات حساب کاربری دسترسی پیدا کند، سرور یک کد غیر مجاز 401 را برمی گرداند.
403 ممنوع
کد 403 Forbidden زمانی بازگردانده می شود که مشتری مجوز دسترسی به منبع درخواستی را نداشته باشد. این ممکن است به این دلیل باشد که مشتری مجاز به دسترسی به منبع نیست، یا به دلیل وجود نداشتن منبع. به عنوان مثال، اگر یک کلاینت سعی کند به منبعی دسترسی پیدا کند که فقط در دسترس مدیران است، سرور یک کد 403 Forbidden را برمی گرداند.
نتیجه
کدهای وضعیت API یک جنبه حیاتی از ارتباطات API هستند. آنها اطلاعات ضروری در مورد نتیجه درخواست های API را در اختیار توسعه دهندگان قرار می دهند و آنها را قادر می سازند تا سیستم های نرم افزاری قوی و قابل اعتمادتری بسازند. با درک انواع مختلف کدهای وضعیت API و معنای آنها، توسعه دهندگان می توانند مکانیسم های مدیریت خطا و پاسخ بهتری را در برنامه های خود ایجاد کنند و تجربه کاربر و عملکرد کلی سیستم را بهبود بخشند.
علاوه بر کدهای وضعیت API که معمولاً استفاده می‌شود، برخی از APIها ممکن است از کدهای وضعیت سفارشی برای ارائه اطلاعات دقیق‌تر در مورد نتیجه درخواست استفاده کنند. به عنوان مثال، یک API ممکن است از کد 422 Unprocessable Entity استفاده کند تا نشان دهد که یک درخواست به خوبی شکل گرفته است اما به دلیل خطاهای معنایی قابل پردازش نیست. برای توسعه دهندگان مهم است که از کدهای وضعیت سفارشی استفاده شده توسط APIهایی که با آنها کار می کنند آگاه باشند.
در نهایت، شایان ذکر است که اگرچه کدهای وضعیت API می توانند برای توسعه دهندگان مفید باشند، اما همیشه به تنهایی کافی نیستند. در برخی موارد، ممکن است لازم باشد اطلاعات اضافی در بدنه پاسخ گنجانده شود تا زمینه فراهم شود و به برنامه مشتری کمک کند تا نتیجه درخواست را درک کند. به عنوان مثال، اگر درخواستی به دلیل محدودیت نرخ با شکست مواجه شود، سرور ممکن است اطلاعاتی درباره زمان بازنشانی محدودیت و تعداد درخواست‌های باقی‌مانده را شامل شود.
به طور خلاصه، کدهای وضعیت API بخش مهمی از ارتباطات API هستند. آنها اطلاعاتی در مورد نتیجه درخواست های API در اختیار توسعه دهندگان قرار می دهند و به آنها کمک می کنند تا سیستم های نرم افزاری قابل اعتمادتر و قوی تری بسازند. با درک انواع مختلف کدهای وضعیت API و نحوه استفاده از آنها، توسعه دهندگان می توانند برنامه های بهتری بسازند و تجربه کلی کاربر را بهبود بخشند.
