۷ قانون در طراحی REST API URI

قبل از  اینکه بحث در مورد قوانین را شروع کنیم، بهتر است با بعضی اصطلاحات آشنا شویم.

URI

REST API ها از Uniform Resource Identifiers (URI) یا شناسانهٔ یکنواخت منبع برای آدرس دهی به منابع(resources) استفاده میکنند. امروزه در دنیای وب، طرح های متفاوتی از URI وجود دارد از طرح های بینظیری که به وضوح منابع را دریافت و ارتباط بین اجزای آنها را مشخص میکنند، مثل:

۱. http://api.example.com/louvre/leonardo-da-vinci/mona-lisa

تا آنهایی که به سخت قابل درک هستند مثل این:

۲. http://api.example.com/68dd0-a9d3-11e0-9f1c-0800200c9a66

یک نکته رو اینجا بگم، شاید منظور از واژه منابع یا resources را متوجه نشده باشید. آدرس اولی را در نظر بگیرید. مثلا در این URI همانطور که میبینید موزه louvre شامل بخش های مختلفی می‌شود که یک بخش از آن به هنرمند معروف leonarodo-da-vinci  اختصاص داده شده و همچنین یکی از آثار این هنرمند تابلو نقاشی mona-lisa است. خوب در اینجا louvre یک منبع یا resource به حساب می آید، که ما توانستیم با این URI به این منبع متصل شویم و اطلاعات مربوط به آن را دریافت کنیم. اینطوری 🙂

خوب است با فرمت URI و نام بخش های مختلف آن آشنا شوید. این یک سینتکس کلیست که RFC 3986  تعریف کرده:  

ادامه مطلب