وب سرویس RESTful (یا REST مخفف Representational state transfer) یک سبک معماری است . وب سرویس هایی که از قوانین REST پیروی می کنند , سرویس های Restful هستند .
در سرویس های Restful , آدرس های URI برای دسترسی به منابع (resources) استفاده می شوند . در واژگان Restful در واقع ما داده ها (Data) و توابع (function) ها را resource می نامیم .
بنابراین داده و توابع مواردی هستند که ما توسط سرویس ها به آنها دسترسی پیدا میکنیم.
در آموزش قبلی وب سرویس restful چیست تمام موارد پایه ای و لازم آورده شده که میتوانید برای ادامه آن را مطالعه بفرمایید.
همچنین آموزش ساخت وب سرویس SOAP که در بانک ها و معمولا درگاه های پرداخت استفاده می شود را می توانید مطالعه بفرمایید.
در اینترنت آموزش های زیادی برای ساخت وب سرویس RESTful وجود دارد ولی نهایتا هیچ یک از آنها حتی از یک قانون REST پیروی نمی کنند و از همان روش های oldSchool که درخواست به یک URL خام و دریافت خروجی آن بصورت داده json است, بهره می برند.!
در این آموزش, به شما نحوه ساخت وب سرویس RESTful در php را نشان می دهیم .
اینجا من از هیچ فریمورکی مثل لاراول (laravel) برای ساخت وب سرویس RESTful در php استفاده نمی کنم . بلکه فقط از php خام بهره می بریم.
بیشتر وقت ها ترجیح میدهم که کد های سفارشی را بدون نیاز به هیچ فریمورک خاصی پیاده سازی کنیم که این عمل مزایای خود را دارد .
مراحل ساخت وب سرویس RESTful در php
- ساخت وب سرویس RESTful
- با PHP خام , بدون استفاده از هیچ فریمورکی
- الگوهای URL باید از قوانین REST پیروی کنند.
- سرویس RESTful باید قابلیت پاسخ به درخواست ها در فرمت داده
jsonو یاxmlرا داشته باشد. - باید طبق سناریو های مختلف قابلیت تفکیک کد وضعیت HTTP را داشته باشد.
- قابلیت تشریح هدر های درخواست (Request Header) داشته باشد.
- تست وب سرویس RESTful توسط کلاینت REST
مثال ساخت وب سرویس RESTful در php
کد php زیر یک کلاس اصلی برای استدلال وبسرویس RESTful است .
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
<?php /* A domain Class to demonstrate RESTful web services */ Class Mobile { private $mobiles = array( 1 => 'Apple iPhone 6S', 2 => 'Samsung Galaxy S6', 3 => 'Apple iPhone 6S Plus', 4 => 'LG G4', 5 => 'Samsung Galaxy S6 edge', 6 => 'OnePlus 2'); /* you should hookup the DAO here */ public function getAllMobile(){ return $this->mobiles; } public function getMobile($id){ $mobile = array($id => ($this->mobiles[$id]) ? $this->mobiles[$id] : $this->mobiles[1]); return $mobile; } } ?> |
ساخت URI وب سرویس RESTful (URI Mapping)
در هنگام ساخت وب سرویس RESTful از url های فرمت بندی شده استفاده کنید . با استفاده از فایل HTACCESS می توانید قابلیت پیمایش URL را بین درخواست و فایل اصلی را داشته باشید . در این مثال ما از دو آدرس URL استفاده می کنیم .
برای دریافت لیست همه موبایل ها :
|
1 |
http://localhost/restexample/mobile/list/ |
برای دریافت لیست جزئیات موبایل ها توسط ID . در مثال زیر ‘۲’ آی دی موبایل است .
|
1 |
http://localhost/restexample/mobile/list/2/ |
فایل .htaccess زیر برای پیمایش بین URL و ارسال درخواست به فایل PHP به کار می رود .
|
1 2 3 4 5 6 7 |
# Turn rewrite engine on Options +FollowSymlinks RewriteEngine on # map neat URL to internal URL RewriteRule ^mobile/list/$ RestController.php?view=all [nc,qsa] RewriteRule ^mobile/list/([0-9]+)/$ RestController.php?view=single&id=$1 [nc,qsa] |
کنترلر وب سرویس RESTful
در فایل .htaccess , ما همه درخواست ها را به فایل RestController.php با کلیدی به نام view برای شناسایی نوع درخواست هدایت (forward) می کنیم.
کد php زیر مربوط به فایل RestController.php است که برای دریافت درخواست و هندل کردن آن بر اساس متد تعریف شده استفاده می شود . از کلید view برای شناسایی نوع درخواست URL استفاده می کنیم .
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
<?php require_once("MobileRestHandler.php"); $view = ""; if(isset($_GET["view"])) $view = $_GET["view"]; /* controls the RESTful services URL mapping */ switch($view){ case "all": // to handle REST Url /mobile/list/ $mobileRestHandler = new MobileRestHandler(); $mobileRestHandler->getAllMobiles(); break; case "single": // to handle REST Url /mobile/show/<id>/ $mobileRestHandler = new MobileRestHandler(); $mobileRestHandler->getMobile($_GET["id"]); break; case "" : //404 - not found; break; } |
یک کلاس پایه ای RESTful
کلاس (class) زیر دارای چند متد است که معمولا در هندلر تمام سرویس RESTful استفاده می شود . یکی از متد ها برای ساختن پاسخ (response) و دیگری برای ذخیره کد وضعیت HTTP و پیام های مربوطه به صورت آرایه ای و key/value تعریف شده اند .
توابع معمول دیگری هم می توانید به این کلاس اضافه و آن را به عنوان کلاس پایه هندلر سرویس RESTful خود استفاده کنید.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
<?php /* A simple RESTful webservices base class Use this as a template and build upon it */ class SimpleRest { private $httpVersion = "HTTP/1.1"; public function setHttpHeaders($contentType, $statusCode){ $statusMessage = $this -> getHttpStatusMessage($statusCode); header($this->httpVersion. " ". $statusCode ." ". $statusMessage); header("Content-Type:". $contentType); } public function getHttpStatusMessage($statusCode){ $httpStatus = array( 100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 306 => '(Unused)', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported'); return ($httpStatus[$statusCode]) ? $httpStatus[$statusCode] : $status[500]; } } ?> |
هندلر وب سرویس RESTful
در هنگام ساخت وب سرویس RESTful در php نیاز است به چند مورد دقت کنید .
اول اینکه هندلر REST تصمیم دارد در چه فرمت داده ای پاسخ درخواست را برگشت دهد . این موضوع بر اساس پارامتر Accept در هدر درخواست تعیین می شود . در اینجا زمانی که درخواستی ارسال شد باید همراه درخواست, پارامتر Accept در هدر ارسالی ست شود . این مقادیر می تواند “application/json” یا application/xml و یا text/html باشد .
دومین موردی که باید دقت کنید , کد های وضعیت (Status Code) است . برای حالت موفقیت آمیز , کد وضعیت ۲۰۰ را برای پاسخ ست و اسال کنید . به طور مشابه , کد های وضعیت متفاوتی وجود دارند که بنابر وضعیت پیش آمده نیاز است که ارسال شود . برای دیدن همه کدهای وضعیت و توضیحات آن ها مقاله کد وضعیت HTTP را مطالعه بفرمایید.
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 |
<?php require_once("SimpleRest.php"); require_once("Mobile.php"); class MobileRestHandler extends SimpleRest { function getAllMobiles() { $mobile = new Mobile(); $rawData = $mobile->getAllMobile(); if(empty($rawData)) { $statusCode = 404; $rawData = array('error' => 'No mobiles found!'); } else { $statusCode = 200; } $requestContentType = $_SERVER['HTTP_ACCEPT']; $this ->setHttpHeaders($requestContentType, $statusCode); if(strpos($requestContentType,'application/json') !== false){ $response = $this->encodeJson($rawData); echo $response; } else if(strpos($requestContentType,'text/html') !== false){ $response = $this->encodeHtml($rawData); echo $response; } else if(strpos($requestContentType,'application/xml') !== false){ $response = $this->encodeXml($rawData); echo $response; } } public function encodeHtml($responseData) { $htmlResponse = "<table border='1'>"; foreach($responseData as $key=>$value) { $htmlResponse .= "<tr><td>". $key. "</td><td>". $value. "</td></tr>"; } $htmlResponse .= "</table>"; return $htmlResponse; } public function encodeJson($responseData) { $jsonResponse = json_encode($responseData); return $jsonResponse; } public function encodeXml($responseData) { // creating object of SimpleXMLElement $xml = new SimpleXMLElement('<?xml version="1.0"?><mobile></mobile>'); foreach($responseData as $key=>$value) { $xml->addChild($key, $value); } return $xml->asXML(); } public function getMobile($id) { $mobile = new Mobile(); $rawData = $mobile->getMobile($id); if(empty($rawData)) { $statusCode = 404; $rawData = array('error' => 'No mobiles found!'); } else { $statusCode = 200; } $requestContentType = $_SERVER['HTTP_ACCEPT']; $this ->setHttpHeaders($requestContentType, $statusCode); if(strpos($requestContentType,'application/json') !== false){ $response = $this->encodeJson($rawData); echo $response; } else if(strpos($requestContentType,'text/html') !== false){ $response = $this->encodeHtml($rawData); echo $response; } else if(strpos($requestContentType,'application/xml') !== false){ $response = $this->encodeXml($rawData); echo $response; } } } ?> |
تست کلاینت وب سرویس RESTful
مرحله آخر از ساخت وب سرویس RESTful در php تست سمت کلاینت وب سرویس است . برای آزمایش کلاینت وب سرویس RESTful , راه های مختلفی وجود دارد .
کلاینت های مستقل زیادی در مارکت ها وحود دارد که معمولا از پلاگین گوگل کروم (Google Chrome) برای شبیه سازی کلاینت REST استفاده میکنم . Advanced Rest Client یکی از پلاگین های گوگل کروم برای تست قسمت کلاینت REST است . این extension را نصب و همانند تصویر زیر استفاده کنید .
اسکرین شات های زیر از تست وب سرویس RESTful بر روی گوگل کروم است .
خروجی XML وب سرویس RESTful
خروجی jSON وب سرویس RESTful
جمع بندی
همانطور که دیدید مبحث ساخت وب سرویس RESTful در php بسیار چالش برانگیز و جالب است و برای تبادل داده بین پلتفرم های مختلف مثال اندروید و وب بسیار این نوع استایل برای وب سرویس مناسب اس.
بسیاری از کاربران به ظاهر حرفه ای ولی مبتدی از روش های قدیمی برای تبادل داده بین پلتفرم ها استفاده میکنند که اغلب هم بسیار آسیب پذیر هستند و آن کارایی و توسعه پذیری را ندارند .
ولی استفاده است قوانین REST برای ساخت وب سرویس های RESTful امروزه بسیار کاربری و پر استفاده است و در پروژه های Cross-Platform ی که می نویسید برای حرفه ای تر شدن کار از REST استفاده کنید .
امیدوارم از آموزش ساخت وب سرویس RESTful در php لذت برده باشید . در مقاله های بعدی در مورد انجام عملیات CRUD بر روی دیتابیس به واسطه REST , احراز هویت , موارد کاربردی دیگر را با شما به اشتراک خواهم گذاشت .
برای دانلود سورس کد کامل از دانلود باکس استفاده کنید
هر سوالی داشتید ، از قسمت نظرات اقدام کنید . سریعا ، پاسخگوی سوالات شما هستیم .
موفق و پیروز باشید.
سلام.
آیا restful سرویس صرفا مربوط به بخش php و هست یا شامل فایل های جاوا در اندروید هم میشه؟
سلام. rest یک استاندارد هستش و اصلا تکنولوژی یا ابزار یا کتابخانه یا هیچ چیز نیست پس قابل تعمیم به تمام زبان ها که به نحوی با url و وب کار می کنند, میتونه باشه
سلام. مطلبتون عالی بود. خسته نباشید. یه سوال داشتم ازتون . مزایای این که واسه این جور کدا از فریمورک خاصی استفاده نمی کنید چیه
سلام. خوشحالم که مفید واقع شده. ممنون.
به دلیل اینکه تنوع فریمورک ها زیاد است و همچنین شاید دوستانی که این مطالب را دنبال می کنند هنوز به سراغ فریمورک خاصی نرفتند و با php خالص کد می زنند, سعی کردیم در بیشتر مطالب آموزشی به اینصورت فهم کدها را چه برای دوستانی که از فریمورک استفاده می کنند یا از php خالص برای کدنویسی بهره می برند, آسان تر کنیم .
موفق باشید.