API های سازمان شما محصولات سازمان شما هستند.

در دنیای دیجیتال امروز، یکی از انواع محصولاتی که هر سازمان ارائه می کند مجموعه API های آن سازمان است. اگر بپذیریم که API محصول سازمان شما هستند باید یک سری ویژگی داشته باشند که در ادامه به آن ها اشاره می کنیم.

اول: کار کردن با آن آسان باشد.

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

دوم: تا حد ممکن از استفاده نا صحیح جلوگیری کند.

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

سوم: پیچیدگی ها را پنهان کند و سطح تجرید مناسب داشته باشد.

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

چهارم: قابلیت کشف داشته باشد.

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

پنجم: مستندات کامل و دقیقی داشته باشد.

هر API نیز مانند هر محصول دیگری نیاز به مستندات کامل دارد تا کاربران نحوه استفاده دقیق آن را درک کنند. برای مثل یک استاندارد مستند سازی به نام Swagger برای API های REST وجود دارد که استفاده از آن می تواند تا حد زیادی ابهامات را کاهش دهد.

ششم: از پروتکل های مختلف پشتیبانی کند.

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

هفتم: ارائه توافقنامه سطح خدمات به مصرف کنندگان

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

هشتم: پشتیبانی از پروتکل هاي مختلف مانند OAuth۲ یا Web -Token براي احراز هویت درخواست ها

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

نهم: ارائه محیط تستی برای API لازم است.

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

دهم: امکان نظارت بر API به منظور بررسی سلامت و نحوه استفاده از آن لازم است.

همه خودروها یک داشبورد دارند که به صورت Real-time راننده را از اوضاع خودرو مطلع می کنند. API هم به عنوان یک محصول به یک داشبورد نیاز دارد که وضعیت ان را برای بهره بردار و ارائه دهنده API روشن کند.

اگر نیاز به مشاوره در خصوص API های سازمان خودتان دارید به وب سایت ما سر بزنید.

ما را در اینستاگرام دنبال کنید.