Paginate while returning array of Api resource objects to the resource collection

Does the code work without paginating?

Yes..Working well with paginate too. The problem is not shown any meta data related to paginate.

I am not sure, but you may need to build the pagination manually with lengthaware. https://laracasts.com/discuss/channels/guides/length-aware-paginator

But have you gone over: https://laravel.com/docs/5.7/eloquent-resources#pagination

yesh ..i followed Laravel document.

And this:

Adding Meta Data

Some JSON API standards require the addition of meta data to your resource and resource collections responses. This often includes things like links to the resource or related resources, or meta data about the resource itself. If you need to return additional meta data about a resource, include it in your toArray method. For example, you might include link information when transforming a resource collection:

/**
 * Transform the resource into an array.
 *
 * @param  \Illuminate\Http\Request
 * @return array
 */
public function toArray($request)
{
    return [
        'data' => $this->collection,
        'links' => [
            'self' => 'link-value',
        ],
    ];
}

Have a look : https://github.com/spatie/laravel-json-api-paginate

I solve this problem using the additional method. Docs: https://laravel.com/docs/5.8/eloquent-resources#adding-meta-data

return ServiceProviderCollection::collection($across_city)
                ->additional([
                    'near_by' => ServiceProviderCollection::collection($near_by)
                ]);

Thank you @mhmudyns! Your trick worked for me. Heck it's not even a trick, it's the most elegant solution than what I found on internet whole day. Thanks again!

Thanks for great answer , worked like a charm.

thank you so much! it worked for me.

thank you so much @mhmudyns

thanks alot.. @mhmudyns

To make your code clean make a PaginationResource to be used across different collections and make single place for editing pagination details

then inside any resource add your Pagination resource as follow

this is Pagination resource

public function toArray($request) : Array
    {
        return [
            'total' => $this->total(),
            'count' => $this->count(),
            'per_page' => $this->perPage(),
            'current_page' => $this->currentPage(),
            'total_pages' => $this->lastPage()
        ];
    }

and add it to any other collection like this

 public function toArray($request) : Array
    {
        $pagination = new PaginationResource($this);

        return [
            'templates' => $this->collection,
            $pagination::$wrap => $pagination,
        ];
    }

Thanks @mhmudyns and @elo! Does anyone have a more elegant way than this to include a status code with the response using these approaches?

I managed to get something working, but the double response seems unintuitive and ...ugly.

    $results = SearchResult::collection(Product::paginate(20));
    return response($results->response()->getData(true), 200);

I know it's not really necessary in this situation, considering these examples are just successful GETs. But it's still something I try to manually specify in responses.

Anyone have any other approaches?

I also run into this trouble sometimes ago and here's how i solved it.

• first create the collection and inside the toArray method return the collection like so:

class CourseCategoryCollection extends ResourceCollection
{
    /**
     * Transform the resource collection into an array.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return array|\Illuminate\Contracts\Support\Arrayable|\JsonSerializable
     */
    public function toArray($request)
    {
        return [
            'data' => $this->collection
        ];
    }
}

then in your controller return this:

$courses = auth()->user()->courses()->with(['categories', 'lessons'])
            ->filter($request)->paginate($request->quantity)->withQueryString();

return new CourseCategoryCollection($courses)

I solved this issue very easily. Just pass your paginated variable to resource. this will only update your data field.no return variable required.also no effect on paginations fields.

    $sessions = Session::paginate(10);
    SessionResource::collection($sessions);
    return response()->json([
        'sessions' => $sessions,
    ]);