PHP Academy · 강의

API 경로 및 리소스 컨트롤러

RESTful 경로를 등록하고 Artisan으로 리소스 컨트롤러를 생성합니다.

API 경로 및 리소스 컨트롤러은(는) CoddyKit의 무료 PHP Academy 강의입니다. 이것은 4개 중 1번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 PHP Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. PHP Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

라라벨의 API 경로

routes/api.php에서 API 경로를 정의합니다. 이러한 경로에는 자동으로 /api 접두사가 붙고 api 미들웨어 그룹이 적용됩니다(상태 비저장 방식이므로 세션과 쿠키가 없습니다).

기본 API 경로

클로저에서 JSON을 반환합니다.

<?php
Route::get("/users/{id}", function (int $id) {
    $user = User::findOrFail($id);
    return response()->json($user);
});

API 리소스 경로

Route::apiResource()는 REST 방식의 경로 5개를 등록합니다. 양식을 표시하는 create와 edit는 제외됩니다.

<?php
// routes/api.php
use App\Http\Controllers\Api\UserController;

Route::apiResource("users", UserController::class);
// GET /api/users           → index
// POST /api/users          → store
// GET /api/users/{user}    → show
// PUT /api/users/{user}    → update
// DELETE /api/users/{user} → destroy

API 컨트롤러 생성

--api 플래그를 사용하면 create와 edit 메서드가 없는 컨트롤러를 생성할 수 있습니다.

$ php artisan make:controller Api/UserController --api --model=User

API 컨트롤러 예시

API 컨트롤러는 JSON 응답을 반환합니다.

<?php
namespace App\Http\Controllers\Api;

class UserController extends Controller
{
    public function index(): JsonResponse
    {
        return response()->json(User::paginate(15));
    }

    public function show(User $user): JsonResponse
    {
        return response()->json($user);
    }

    public function store(StoreUserRequest $request): JsonResponse
    {
        $user = User::create($request->validated());
        return response()->json($user, 201);
    }

    public function destroy(User $user): JsonResponse
    {
        $user->delete();
        return response()->json(null, 204);
    }
}

HTTP 상태 코드

적절한 상태 코드를 반환합니다: 200 (OK), 201 (생성됨), 204 (콘텐츠 없음), 400 (잘못된 요청), 401 (인증되지 않음), 403 (금지됨), 404 (찾을 수 없음), 422 (처리할 수 없는 엔터티).

폼 요청 유효성 검사

깔끔하고 재사용 가능한 유효성 검사 규칙에는 Form Request를 사용합니다.

$ php artisan make:request StoreUserRequest

StoreUserRequest 예시

요청 클래스에서 규칙과 권한 부여를 정의합니다.

<?php
class StoreUserRequest extends FormRequest
{
    public function authorize(): bool { return true; }
    public function rules(): array {
        return [
            "name"  => "required|string|max:255",
            "email" => "required|email|unique:users",
        ];
    }
}

API 경로 그룹화

접두사와 네임스페이스를 사용하여 API 경로를 그룹화합니다.

<?php
Route::prefix("v1")->middleware("auth:sanctum")->group(function () {
    Route::apiResource("posts", PostController::class);
    Route::apiResource("users", UserController::class);
});

except() 및 only()

리소스 등록에서 특정 경로를 제외하거나 제한합니다.

<?php
Route::apiResource("users", UserController::class)->only(["index", "show"]);
Route::apiResource("posts", PostController::class)->except(["destroy"]);

중첩 리소스

관련 모델에 대한 중첩 리소스 경로를 등록합니다.

<?php
Route::apiResource("users.posts", UserPostController::class);
// GET /api/users/{user}/posts/{post}

요약

routes/api.php에서 REST 방식의 API 경로를 만들 때 Route::apiResource()를 사용합니다. --api로 컨트롤러를 생성합니다. 적절한 HTTP 상태 코드와 함께 JSON을 반환합니다. Form Request로 유효성을 검사합니다.

빠른 확인

apiResource()는 경로를 몇 개 등록합니까?

자주 묻는 질문

“API 경로 및 리소스 컨트롤러” 강의는 무료인가요?

네 — “API 경로 및 리소스 컨트롤러” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 PHP Academy 강의 전체를 잠금 해제할 수 있습니다. PHP Academy 강의에는 총 4개의 강의가 포함되어 있습니다.

“API 경로 및 리소스 컨트롤러”에서 뭘 배우나요?

RESTful 경로를 등록하고 Artisan으로 리소스 컨트롤러를 생성합니다. 브라우저에서 직접 실행하는 실습 코드로 PHP Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.

PHP Academy을(를) 시작하는 데 경험이 필요한가요?

사전 경험은 필요하지 않습니다. CoddyKit의 PHP Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 1번째 강의입니다.

“API 경로 및 리소스 컨트롤러” 강의는 얼마나 걸리나요?

대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.

이 PHP Academy 강의에서 코드를 작성하고 실행할 수 있나요?

네. 모든 PHP Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.

이 강의의 모든 강의

← PHP Academy(으)로 돌아가기