PHP در سال 1995 و تنها سه هفته پس از جاوا منتشر شد. امروزه هر دو در ده زبان محبوب باقی مانده اند. با سهولت استفاده عمومی PHP، گزینه هایی برای چگونه برای استفاده از آن فراوان است. با این حال، هر آموزش PHP به یک اندازه ایجاد نمی شود. به همین دلیل است که ما این آموزش Postman QuickStarts را برای مبتدیان در مورد ساخت API REST با PHP گردآوری کردیم. ما از چیزی که فکر می کنیم یک چارچوب ساده برای این منظور استفاده می کنیم: لاراول.
لاراول یک فریمورک محبوب برنامه وب PHP است که با ابزارها و ویژگی های داخلی مختلفی برای ساخت API ارائه می شود. در این آموزش، ما یک API ساده ایجاد می کنیم که به کاربران اجازه می دهد داده ها را اضافه و بازیابی کنند.
قبل از اینکه شروع کنیم…
دوبار بررسی کنید که آماده نوشتن در PHP هستید. فقط آشنایی اولیه برای این آموزش لازم است، و PHP منحنی یادگیری بسیار مسطحی برای کاربران جدید دارد—ما شما را تشویق می‌کنیم در هر سطح مهارتی امتحان کنید.
سپس، تأیید کنید که موارد زیر نصب شده اند:
اگر دستورالعمل‌های گام به گام برای نصب هر یک از موارد بالا را می‌خواهید، به راهنمای کامل راه‌اندازی سریع Laravel API در Postman مراجعه کنید. به علاوه، شما همچنین می خواهید ویرایشگر کد مورد علاقه خود را باز کنید. حالا بیایید شروع کنیم!
مرحله 1: پروژه لاراول خود را شروع کنید
پروژه لاراول خود را داربست کنید
قبل از اینکه بتوانیم هر کدی بنویسیم، باید یک پروژه لاراول را داربست کنیم. با تشکر از Composer، این نسبتا ساده است. یک ترمینال را باز کنید و به فهرستی که این پروژه در آن زندگی می کند بروید. دستور زیر را در ترمینال وارد کنید:
composer create-project laravel/laravel laravel_project
این ممکن است کمی طول بکشد. ده ها مگابایت برای دانلود و نصب وجود دارد.
وقتی کار تمام شد، یک پوشه پروژه به نام خواهید داشت laravel_project.
یه تست بده
حرکت به laravel_project پوشه و دستور زیر را در ترمینال وارد کنید:
php artisan serve --port=8080
این پروژه شما را در http://localhost:8080. اگر از قبل فرآیندی با استفاده از پورت دارید، پورت را به چیز دیگری تغییر دهید. وقتی در حال اجرا است، از URL بازدید کنید. این صفحه اصلی را باز خواهد گرداند.
در پایین سمت راست یادداشت کنید، شماره نسخه لاراول و PHP را خواهید دید. اگر به دنبال آموزش هستید، پیدا کردن آموزش هایی برای لاراول و PHP که تا حد امکان به آن نسخه ها نزدیک باشد، به کاهش مشکلات کمک می کند.
بیایید به افزودن یک API ادامه دهیم.
مرحله 2: یک API بسازید
مسیر را ایجاد کنید
این یک API عمومی بدون احراز هویت ایجاد می کند.
باز کن routes/api.php در دایرکتوری پروژه لاراول خود در ویرایشگر خود. در پایان کد زیر را اضافه کنید:
Route::get('/hello', function () {
return "Hello World!";
});
این اضافه می کند /api/hello نقطه پایانی و “Hello World” را به صورت متنی ساده به یک درخواست GET برمی گرداند.
توجه داشته باشید که چگونه نقطه پایانی با پیشوند بود /api توسط لاراول
بعد، اجازه دهید این نقطه پایانی را در Postman بنامیم.
مرحله 3: اولین نقطه پایانی خود را امتحان کنید
برای آزمایش این در Postman، فضای کاری شخصی خود را باز کنید و مجموعه ای را راه اندازی کنید. نام آن را “Laravel QuickStart” یا چیز دیگری که ترجیح می دهید بگذارید.
پس از ایجاد، انتخاب کنید یک درخواست اضافه کنید برای شروع.
URL درخواست را تنظیم کنید localhost:8080/api/hello و مطمئن شوید که برنامه Postman Desktop Agent روی دستگاه شما اجرا می شود تا از بروز هرگونه مشکل CORS هنگام آزمایش محلی جلوگیری کنید.
انتخاب کنید ارسال و بخش پاسخ در زیر بخش درخواست پاسخی را نشان می دهد Hello World! در متن ساده با الف 200 OK کد پاسخ.
تبریک می گویم. شما اولین نقطه پایانی API خود را در لاراول ایجاد کردید و با موفقیت آن را با Postman فراخوانی کردید.
بعد، بیایید یک نقطه پایانی ساده POST برای سرگرمی ایجاد کنیم.
مرحله 4: یک نقطه پایانی POST اضافه کنید
به خودت برگرد routes/api.php فایل و موارد زیر را اضافه کنید:
Route::post('/reverse-me', function (Request $request) {
$reversed = strrev($request->input('reverse_this'));
return $reversed;
});
این یک مسیر POST برای نقطه پایانی اضافه می کند api/reverse-me. رشته ای را که در متن پست با نام پارامتر ارسال می کنید معکوس می کند reverse_this.
بیایید این را در بخش بعدی امتحان کنیم.
مرحله 5: نقطه پایانی POST خود را امتحان کنید
به مجموعه Laravel QuickStart خود در Postman بازگردید و یک درخواست اضافه کنید. نام آن را Reverse بگذارید و مراحل زیر را دنبال کنید:
- نوع درخواست را تنظیم کنید
POST. - نقطه پایانی را روی
localhost:8080/api/reverse-me. - انتخاب کنید بدن برگه
- در منوی کشویی بالا در تب، را انتخاب کنید x-www-form-urlencoded.
- اضافه کردن یک پارامتر از
reverse_thisبا ارزشesrever. این “معکوس” قبلاً معکوس شده است، بنابراین مقدار بازگشتی به راحتی قابل خواندن خواهد بود. - انتخاب کنید ارسال
API رشته را به صورت معکوس در متن ساده برمی گرداند. تبریک می گویم! شما یک REST API با PHP و Laravel ایجاد کرده اید.
خلاصه
در این پست وبلاگ، نحوه ایجاد یک API ساده مبتنی بر PHP با چارچوب لاراول را بررسی کردیم. ما هر دو نقطه پایانی GET و POST API را ایجاد کردیم و از Postman برای آزمایش آن نقاط پایانی استفاده کردیم. با دنبال کردن این آموزش، اکنون باید درک کاملی از نحوه ایجاد یک API پایه با لاراول و نحوه آزمایش آن با استفاده از Postman داشته باشید.
جلوتر رفتن…
اگر می خواهید دانش خود را در مورد لاراول و پستمن عمیق تر کنید، این تمرین ها را امتحان کنید:
- در اسناد Laravel 10.x شیرجه بزنید تا یک کنترلر برای رسیدگی به درخواست های پیچیده تر اضافه کنید و/یا یک مدل برای اتصال پایگاه داده اضافه کنید.
- اسناد رسیدگی به خطای Laravel 10.x را مرور کنید تا بهترین روش‌ها برای مدیریت خطا در لاراول را بیاموزید، مثلاً اگر شخصی یک فایل باینری را به‌جای رشته‌ای به نقطه پایانی معکوس رشته شما ارسال کند، چه اتفاقی می‌افتد.
- اسناد تست Postman را کاوش کنید و روی درخواست POST یک تست بنویسید تا مطمئن شوید که رشته reverse_this به درستی معکوس شده است.
برای راهنماهای گام به گام بیشتر مانند این راهنمای Postman Quick Starts را بررسی کنید. اگر می‌خواهید خودتان مشارکت کنید، به مخزن Postman Quickstarts در GitHub بروید.
