@ddymkoدیوید دیمکو
سرپرست فنیvultr که روی همه موارد Kubernetes و API کار می کند
در حالی که یک فنجان قهوه ممکن است به نظر دو قسمت آب گرم و قهوه آن باشد
خرد می کند ، چیزهای بیشتری در آن وجود دارد. همین مورد را می توان در مورد یک API خوش طراحی نیز گفت. یک API خوب فراتر از صرف ورودی و برگشت خروجی است. چند مورد اصلی ارائه می دهد که کار با آن را لذت بخش و آسان می کند.
این چند مورد اصلی گاهی اوقات قابل چشم پوشی است و یا اینکه صیقل اضافی که شایسته آن است و باعث کاهش API می شود ، بدست نمی آید. در زیر به این موارد و چگونگی بهبود تجربه API می پردازیم.
مستندات
اولین تعاملی که هر توسعه دهنده با API انجام می دهد مستندات آن است. اسناد خوب آموزنده و واضح است که به توسعه دهندگان اجازه می دهد تا به سرعت با API ادغام شوند.
بیایید اسناد موجود در اسناد و مدارک ما را برای تماسی که به ما امکان می دهد یک دانه قهوه ایجاد کنیم ، شبیه کنیم.
Create Coffee Bean
Description :This will create a coffee bean resource
Endpoint : /coffee-beans
Method: Post
Request Body Schema: application/json
Fields :
type string (required) : Type of coffee bean
region string (required) : Region from where coffee is from
roast string (required) : Type of roast for this coffee bean
limited boolean (optional) : If this bean is a limited batch
quantity...