Laravel에서 API 리소스를 사용하는 방법은 무엇입니까?

API 리소스 사용은 Laravel에서 RESTFUL API를 구축 할 때 구조화 된 JSON 응답을 반환하는 권장 방법입니다. 1. PHP Artisan Make 사용 : 리소스 Postresource를 사용하여 리소스 클래스를 생성합니다. 2. id, title, create_at 등과 같은 ToArray 메소드에서 리턴 필드를 정의하십시오. 3. New Postresource ($ post) 또는 postresource :: Collection ($ posts)을 반환합니다. 4. 새로운 UserResource를 통해 중첩 관계를 처리합니다 ($ this-> WhenLoaded ( '사용자')); 5. 널 리턴을 피하기 위해 필드를 포함시키기 위해 $ this-> when () 조건을 사용하십시오. 6. 페이징 정보와 같은 추가 () 방법을 통해 메타 데이터 추가; 7. 사전로드 관계, n 1 쿼리 피하기, 자원 논리를 간결하게 유지하는 것을 포함한 모범 사례를 따르십시오. 이러한 방식으로 Laravel은 일관되고 유지 관리 가능한 JSON 응답을 자동으로 생성하고 API의 가독성과 성능을 향상 시키며 궁극적으로 효율적인 데이터 출력을 달성 할 수 있습니다.

Laravel에서 API 리소스를 사용하는 것은 특히 편안한 API를 구축 할 때 모델과 컬렉션을 JSON 응답으로 변환하는 깨끗하고 효율적인 방법입니다. Laravel의 API 리소스를 사용하면 반환되는 데이터와 구성 방법을 정확하게 제어하여 응답을 일관되고 유지 관리 할 수 있도록 도와줍니다.

Laravel에서 API 리소스를 사용하는 방법은 다음과 같습니다.

1. API 리소스를 만듭니다

먼저, 장인을 사용하여 자원을 생성하십시오. Post 모델의 경우 실행 :

 PHP Artisan Make : 자원 postresource

이것은 app/Http/Resources 디렉토리에서 PostResource 클래스를 만듭니다.

컬렉션 (예 : 게시물 목록)으로 작업하는 경우 Laravel은이를 자동으로 처리 할 수있는 방법도 제공합니다.

리소스 컬렉션을 만들 수도 있습니다.

 PHP Artisan Make : 자원 후 수집

그러나 Laravel 8의 기간 동안 ResourceCollection 기본 리소스에 내장되어 있으므로 일반적으로 하나의 리소스 클래스가 필요합니다.

2. 자원 구조를 정의합니다

app/Http/Resources/PostResource.php 오픈. toArray 메소드는 응답에 포함 된 데이터를 정의합니다.

 <? php

네임 스페이스 앱 \ http \ 리소스;

Illuminate \ http \ resources \ json \ jsonResource를 사용하십시오.

클래스 Postresource는 JSONRESOURCE를 확장합니다
{
    공개 기능 toArray ($ 요청)
    {
        반품 [
            &#39;id&#39;=> $ this-> id,
            &#39;title&#39;=> $ this-> title,
            &#39;content&#39;=> $ this-> content,
            &#39;create_at&#39;=> $ this-> create_at-> format ( &#39;ymd h : i : s&#39;),
            &#39;author&#39;=> $ this-> whenloaded ( &#39;user&#39;, function () {
                새로운 USERRESOURCE ($ this-> user)를 반환합니다.
            }),
        ];
    }
}

? $this->whenLoaded() 사용하여 이미로드 된 경우에만 (n 1 쿼리를 피하기 위해) 조건부로 포함하십시오.

3. 컨트롤러에서 리소스를 사용하십시오

컨트롤러에서 모델 또는 컬렉션을 리소스로 래핑하십시오.

 App \ http \ resources \ postresource를 사용합니다.
app \ models \ post를 사용합니다.

// 단일 게시물을 반환합니다
공개 기능 쇼 (Post $ Post)
{
    New Postresource를 반환합니다 ($ post);
}

// 게시물 목록을 반환합니다
공개 기능 색인 ()
{
    postresource :: collection (post :: with ( 'user')-> get ());
}

또는 Pagination (API의 공통) :

 공개 기능 색인 ()
{
    postresource :: collection (post :: paginate (10));
}

Laravel은 자동으로 Pagination 구조를 처리합니다.

4. 관계 작업 (중첩 자원)

게시물에 사용자가있는 경우 UserResource 작성합니다.

 PHP Artisan Make : Resource Userresource

그런 다음 PostResource 내부에서 사용하십시오.

 '저자'=> 새로운 userresource ($ this-> whenloaded ( 'user')),

이것은 귀하의 응답을 구조화하고 재사용 할 수있게합니다.

5. 조건부 속성

조건부로 필드를 포함시키기 위해 when() 사용하십시오.

 'published_at'=> $ this-> when (! empty ($ this-> published_at), $ this-> published_at),
'view'=> $ this-> shen ($ this-> resource-> relationloaded ( 'stats'), $ this-> views),

데이터가 관련이 없을 때 null 값을 보내는 것을 피합니다.

6. 최상위 응답 사용자 정의 (리소스 컬렉션)

래퍼 (예 : 메타 데이터 추가)를 사용자 정의하려면 toResponse 메소드를 무시하거나 익명 리소스 컬렉션을 사용하십시오.

예를 들어, 컨트롤러에서 :

 Illuminate \ http \ resources \ json \ anonymousresourcececelection을 사용하십시오.

public function index () : AnonymousResourceCollection
{
    $ post = post :: paginate (10);

    postresource :: collection ($ posts)-> 추가 ([[[
        '메타'=> [
            'Total_Pages'=> $ post-> lastPage (),
            'current_page'=> $ post-> currentPage (),
        ],,
    ]);
}

새로운 리소스 클래스를 작성하지 않고 추가 정보가 추가됩니다.

7. 모범 사례

• 성능 문제를 피하기 위해 자원에 사용 된 항상 열망하는 부하 관계 .
• 선택적 관계에 whenLoaded() 사용하십시오.
• 자원 논리를 간단하게 유지하십시오 - 비즈니스 로직을 내부에 넣지 마십시오.
• 필요한 경우 다른 API 버전에 다른 리소스를 사용하십시오 (예 : V1\PostResource ).

Laravel에서 API 리소스를 사용하면 API 응답을 예측할 수 있고 유지 관리하기 쉽습니다. 출력을 완전히 제어 할 수 있으며 Laravel은 JSON 구조 및 상태 코드를 자동으로 처리합니다.

기본적으로 모델을 리소스로 래핑하고 toArray() 메소드를 정의하고 컨트롤러에서 반환하십시오.

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