نامگذاری API خود را از قبل برنامه‌ریزی کنید، و به آنچه که بهترین کار را می‌کند، پایبند باشید.
نقطه پایانی API نقطه اتصال بین دو برنامه نرم افزاری است. APIها برای هر منبع نقطه پایانی دارند. نقاط پایانی محل دقیق یک منبع را در سرور مشخص می کنند.
هنگامی که یک برنامه مشتری اطلاعاتی را از سرور درخواست می کند، از طریق API می رود. که سپس به درخواست دسترسی پیدا می کند و پاسخ سرور را پردازش می کند. سپس API اطلاعات درخواستی را از نقطه پایانی به برنامه منتقل می کند.
API شما در صورتی کارآمد است که بتواند از طریق نقاط پایانی خود به طور موثر ارتباط برقرار کند. دسترسی به منابع را برای کاربران آسان تر می کند و تجربه کاربر را بهبود می بخشد.
یک API Endpoint چگونه کار می کند؟
سیستم های یکپارچه از طریق API ها ارتباط برقرار می کنند. یک سیستم با استفاده از قالبی مانند SOAP یا REST درخواستی را به API ارسال می کند. سرور درخواست ها را دریافت می کند و پاسخ را به API منتقل می کند. محل آن منبع درخواستی نقطه پایانی است.
قبل از اینکه نقطه پایانی یک درخواست را پردازش کند، مشتری باید یک URL، سرصفحه ها و یک بدنه ارائه دهد. سرصفحه ها حاوی ابرداده در مورد یک درخواست و داده های جزئیات بدنه ارسال شده به سرور هستند. یک سرور همچنین می تواند به پایگاه داده ای متصل شود که روش های API می توانند به آن دسترسی داشته باشند.
نقاط پایانی API معمولاً با روش‌های HTTP مانند GET، DELETE، PATCH یا POST کار می‌کنند. روش ها نحوه استفاده از نقطه پایانی را تعیین می کنند. هنگامی که مشتری درخواستی را ارسال می کند، باید آن را طوری فرموله کند که شامل روش درخواست و همچنین URL باشد، به عنوان مثال:
GET https://example.com/books/authors
نامگذاری دشوار است، چه نقاط پایانی API، دستگاه های سخت افزاری شبکه، یا توابع و متغیرها. شما باید در مورد برخی از بهترین روش‌هایی که می‌توانید برای اطمینان از دارایی بودن نقاط پایانی API خود استفاده کنید، یاد بگیرید.
1. از اسلش رو به جلو استفاده کنید
همیشه از اسلش های رو به جلو برای جداسازی منابع URI استفاده کنید. اسلش ها همچنین به نشان دادن سلسله مراتب منابع کمک می کنند. نمونه زیر است:
https://example.com/books/authors
2. از اسم ها استفاده کنید نه افعال
برای نامگذاری یک منبع فقط باید از اسم ها استفاده کنید. اسامی توصیف می‌کنند که یک منبع برای چه چیزی است، در مقابل فعل‌هایی که آنچه را که یک منبع انجام می‌دهد توصیف می‌کند. در اینجا یک مثال از یک روش خوب و بد برای نامگذاری نقاط پایانی API آورده شده است.
نامگذاری بد:
https://example.com/api/getBooks
نامگذاری خوب:
http://example.com/api/books
3. از اسم های جمع استفاده کنید نه مفرد
شما همیشه باید نقاط انتهایی API خود را در اسامی جمع نامگذاری کنید. این به کاربر نشان می دهد که بیش از یک منبع در سرور وجود دارد. استفاده از اسم مفرد ممکن است کاربر را گیج کند و فکر کند تنها یک منبع وجود دارد.
نامگذاری بد:
https://example.com/api/book/3
نامگذاری خوب:
http://example.com/api/books/3
4. از حروف کوچک استفاده کنید
شما باید تمام URL ها را با حروف کوچک تایپ کنید. این شامل نشانی‌های وب نقطه پایانی API است. به عنوان مثال:
نامگذاری بد:
http://example.com/api/Books/3
نامگذاری خوب:
http://example.com/api/books/3
5. از خط فاصله برای جدا کردن کلمات استفاده کنید
از خط فاصله برای جدا کردن کلمات ترکیبی استفاده کنید. خط تیره عبارات خواندنی تری نسبت به حرف شتر یا زیرخط می دهد. آنها همچنین برای اهداف سئو بهتر هستند.
نامگذاری بد:
https://example.com/api/books/33/front_cover
نامگذاری خوب:
https://example.com/api/books/33/front-cover
6. پسوند فایل را اضافه نکنید
شما نیازی به افزودن پسوند فایل به نقاط پایانی API خود ندارید. اگرچه بر خروجی تأثیر نمی گذارد، اما یک برنامه افزودنی خواندن منبع را دشوارتر می کند. همچنین باعث می شود منبع انعطاف پذیری کمتری داشته باشد و در صورت تغییر برنامه افزودنی در آینده، آن را از بین می برد.
نامگذاری بد:
https://example.com/api/books.xml
نامگذاری خوب:
https://example.com/api/books
7. شامل نسخه
شما همیشه باید نقاط پایانی API خود را بر اساس نسخه نامگذاری کنید. اگر در حال ایجاد تغییرات عمده در API هستید، این مهم است. به تمایز بین دو یا چند نسخه API کمک می کند که منبع از کجا آمده است. می توانید نسخه را در ابتدای نقطه پایانی نشان دهید.
مثلا:
https://example.com/api/v3/books
چرا بهترین روش های API را در نظر بگیرید؟
API ها به ستون فقرات برنامه نویسی مدرن تبدیل شده اند. آنها همکاری را بهبود می بخشند، نوآوری را تشویق می کنند و امنیت برنامه را بهبود می بخشند.
چه با استفاده از ابزارهای جدید و چه مدیریت ابزارهای موجود، APIها فرآیند را ساده می کنند. بنابراین وجود نقاط پایانی که تجربه کاربر را بهبود می بخشد ضروری است. نامگذاری و ساختار نقاط پایانی API شما عملکرد API شما را تعیین می کند.
مطمئن شوید که از بهترین شیوه ها برای ایجاد نقاط پایانی API کارآمد استفاده می کنید.