I dropped this library into one of my projects, but some of the tests started failing because the default value of [] is converted to [ 'success' => true ]. This makes sense if you just call return $this->respondWithSuccess() with no arguments, but in my case I'm returning an array of some models and when there aren't any in the database I actually want the response to be an empty array.

I ended up using my own method with null as the default:

    public function respondWithSuccess($contents = null): JsonResponse
    {
        $contents = $this->morphToArray($contents ?? [ 'success' => true ]);

        return $this->apiResponse($data);
    }

Didn't want to just create a PR though since I know this would be a breaking change.

1. Pulled out default success response data to a field
2. Added fluent method for setting default success response data
3. Added tests for usage of new method
4. Added missing tests for null values in respondWithSuccess, respondCreated, respondNoContent and fixed problems
   • null values were allowed both in types and phpdocs, yet exceptions were thrown when passed, this is fixed and null values are returned as empty arrays
5. Added missing tests for Arrayable, JsonSerializable and Collection and their empty variants
6. Strengthened tests to use strict assertions

Issue

• https://github.com/f9webltd/laravel-api-response-helpers/issues/11

Description

• updated ResponseTest
• created User model for the test
• created UserResource for the test

As the package now supports content types other than arrays, it would be good to test common use cases.

The tests currently cover array and Laravel collection types.

Ideally having tests covering Eloquent collections and API resources would be good.

This will also require updating workflows.

I'd imagine we'd end up with something similar to https://github.com/f9webltd/laravel-deletable/tree/master/tests.

This commit adds the following config files:

• .editorconfig
• .gitattributes
• phpunit.xml.dist

and also update composer.json test script so it can use phpunit.xml.dist

P.S.: I know this is a small contribution, but could you please add a hacktoberfest-accepted label on it? I really appreciate it!

merging the response array instead of overwriting it would make it possible to just add data. Like this:

$this->respondWithSuccess(['token' => $superSecret]);

----------

{
  "success": true,
  "token": "n8tJiZrIS8"
}

you could still overwrite the success value:

return $this->respondWithSuccess(['success' => "maybe", 'token' => superSecret]);

----------

{
  "success": "maybe",
  "token": "Ru4nL9IxE3"
}

Hi There This is a good work and a very useful package but wee need a response function for pagination

  public function returnDataPagination($paginator,contents,$page)
    {
        if($paginator->url($page))
        {
           $contents = $this->morphToArray($contents);

          $data = [] === $contents
              ? ['success' => true]
              : $contents;
            return $this->apiResponse($data);
        }
    }

this is the function I hope this help thanks

As a developer sometimes I'd like to respond with a file in certain routes, e.g.

Instead of constructing a response like:

    /**
     * Returns the file as a response.
     *
     * @return Response
     */
    public function getInvoiceAsPdf(): Response
    {
        $file = Storage::disk($this->disk)->file('invoice.pdf');

        return new Response($file, Response::HTTP_OK, [
            'Content-Type'        => 'application/pdf',
            'Content-Disposition' => 'attachment; filename="invoice.pdf"',
            'Content-Length'      => strlen($file),
        ]);
    }

I can simply do

    /**
     * Returns the file as a response.
     *
     * @return Response
     */
    public function getInvoiceAsPdf(): Response
    {
        $file = Storage::disk($this->disk)->file('invoice.pdf');

        $this->respondWitFile($file);
    }

Hi,

The respondFailedValidation method simply returns a message and the response looks like this if multiple errors are present:

{
    "message": "The test field is required. (and 1 more error)"
}

Wouldn't it be better if we could know on which field the error occurs? (and have the error code so we can do the translation outside the API maybe).

Example:

{
    "message": "validation_rule_failed",
    "errors": {
        "myField.required": {
            "code": "validation_rule_required",
            "field": "myField",
            "message": "The test field is required."
        }
    }
}

What do you think about this?

Thank you.

I'm a bit confused about the method respondNoContent. The current signature is: public function respondNoContent(?array $data = []) But as it responds with the status code 204, shouldn't it's signature be public function respondNoContent(), so it does not return any content as indicated by the status?

Here's what I was envisioning with #9 ! This is basically the same thing that also happens inside JsonResources:

https://github.com/laravel/framework/blob/76380cfc6a675d9ad0b1714d6268de13ce406758/src/Illuminate/Http/Resources/Json/JsonResource.php#L98-L102

Finally, I got some time to work on this, I'm not sure if this is the correct approach but I decided to create a new trait for file-related operations. Please let me know your thoughts.

For #21