Laravel에서 API를 작성하는 방법

Laravel은 인기 있는 PHP 프레임워크로서 개발자가 API를 작성하는 첫 번째 선택이 되었습니다. Laravel을 사용하면 기업 및 개인 개발자들 사이에서 점점 인기를 얻고 있는 고품질 API를 빠르게 작성할 수 있습니다.

이 글에서는 Laravel을 사용하여 API를 작성하는 방법을 살펴보겠습니다. API 구축, API 라우팅, 컨트롤러 및 API 테스트와 같은 측면부터 시작하겠습니다.

Building API

API를 구축할 때는 Laravel에서 제공하는 내장 미들웨어와 라우터를 사용해야 합니다. Laravel 5.5부터 프레임워크에는 API 리소스 컨트롤러 기능이 내장되어 있습니다. 이 기능을 통해 개발자는 표준 REST API를 더 빠르게 생성하고 코드 일관성을 유지할 수 있습니다.

리소스 컨트롤러를 어떻게 사용하나요? 먼저 명령줄에서 다음 명령을 실행하여 새 컨트롤러를 만듭니다.

php artisan make:controller Api/PostController --api

이렇게 하면 자동으로 Laravel的内置的ResourceController를 상속하고 사전 정의된 모든 메서드를 포함하는 PostController라는 API 컨트롤러가 생성됩니다. 이러한 방법에는 색인화, 표시, 저장, 업데이트 및 삭제가 포함됩니다.

API 라우팅

Laravel에서 라우팅은 컨트롤러와 긴밀하게 결합되어 있습니다. API 요청을 처리하는 라우팅에서 최상위 컨트롤러를 정의해야 하기 때문입니다.

Route::prefix('api')->group(function () {
    Route::resource('posts', 'Api\PostController');
});

이 라우트는 Post 모델의 CRUD 기능을 구동하는데 사용되는 '/api/posts' URL을 정의합니다.

Controllers

리소스 컨트롤러에서는 사전 정의된 함수를 사용하여 일반적인 작업을 처리할 수 있습니다. 예를 들어 다음 코드는 게시물 기사의 파일 업로드 생성 및 첨부를 시작하여 파일을 저장소에서 공개 디렉터리로 이동합니다.

public function store(Request $request)
{
    $path = $request->file('photo')->store('public/photos');
    
    $post = new Post;
    
    $post->title = $request->input('title');
    $post->description = $request->input('description');
    $post->slug = str_slug($request->input('title'));
    $post->photo = $path;
    
    $post->save();
    
    return new Resource($post);
}

API 테스트

API 테스트는 기능이 제대로 작동하는지 확인하는 데 중요합니다. API Write 테스트 케이스를 작성할 때. Laravel에는 테스트 사례를 쉽게 작성하는 데 도움이 되는 프레임워크 테스트 도구도 내장되어 있습니다.

API에 대한 테스트를 작성할 때 HTTP 요청을 보내고 응답을 확인하여 컨트롤러를 테스트할 수 있습니다. 예를 들어, 다음 코드는 컨트롤러가 게시물 목록을 올바르게 가져올 수 있는지 테스트합니다.

public function testPostIndex()
{
    $response = $this->json('GET', '/api/posts');
    
    $response->assertStatus(200);
    $response->assertJsonStructure([
        'data' => [
            '*' => [
                'id',
                'title',
                'description',
                'slug',
                'photo',
                'created_at',
                'updated_at'
            ]
        ]
    ]);
}

Conclusion

Laravel에서는 API 작성이 매우 쉽습니다. 사전 정의된 API 컨트롤러와 내장 라우터를 사용하면 표준 REST API를 빠르게 생성할 수 있습니다. Laravel의 테스트 도구를 사용하여 API 기능이 제대로 작동하는지 확인하는 테스트 케이스를 작성하세요. 뛰어난 문서화와 커뮤니티 지원은 Laravel을 개발자에게 가장 인기 있는 프레임워크 중 하나로 만드는 핵심 요소입니다.

위 내용은 Laravel에서 API를 작성하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!