laravel-apidoc-generator ignore the transformers during docs generation

[diaafares]

laravel-apidoc-generator ignore the transformers during docs generation
look at the response in following screen shot and notice how delicious is 1:

but if I use Postman, the delicious is displayed correctly as true:

here's the code that generates the response:

public function show($id)
    {
        $fruit = Fruit::where('id', $id)->first();

        if ($fruit) {
            return $this->item($fruit, new FruitsTransformer);
        }

        return $this->response->errorNotFound();
    }

and the full code can be found at:
https://github.com/devmatic/fruits-api/

+1

[micheallue]

I have a question, only GET method can look respone?
I try POST method, but only got "Example request",
but GET method can got "Example request" and "Example respones".

[mpociot]

@micheallue Even though this isn't related to this issue: Yes, it's only possible to get the response for GET requests, because POST requests usually have some kind of validation, which the generator doesn't know about.

@diaafares I think the transformation gets lost because I decode and reencode the JSON data, to apply JSON_PRETTY_PRINT to it.

See:

laravel-apidoc-generator/src/resources/views/documentarian.blade.php

Line 69 in 0b692e3

{!! json_encode(json_decode($parsedRoute['response']), JSON_PRETTY_PRINT) !!}

[micheallue]

@mpociot Thansk your answer. I see. But have other question.
I watch the example web page

But I dont know how to do it. Its add "tooc_footers in index.md? like this?

But after everyone generate command, index.md file will be refresh to the default type.
How can I do it? or have more detailed example?
Thank you.

[diaafares]

<?php
namespace App\Transformers;
use App\Fruit;
use League\Fractal\TransformerAbstract;
class FruitsTransformer extends TransformerAbstract
{
    public function transform(Fruit $fruit)
    {
        return [
            'id'        => (int) $fruit->id,
            'name'      => ucfirst($fruit->name),
            'color'     => ucfirst($fruit->color),
            'weight'    => $fruit->weight . ' grams',
            'delicious' => (bool) $fruit->delicious,
        ];
    }
}

@mpociot please notice that I concatenate ' grams' string to the weight and it not appear in the docs response!
So maybe not the decoding and encoding is the reason cause this issue.

[micheallue]

@mpociot I find solution. thanks.

[mpociot]

@diaafares that's strange - I just added a test to it, which is passing

a73f21a#diff-811766f6298570576208dea9c97d502aR38

[renggasaksono]

+1

[mpociot]

Can someone provide me a test case to reproduce this?

[Belphemur]

@mpociot you should use the package Fractal with the DataArray as serializer (or simply test with Dingo, it's the default)

That return an object like

{  
   "data": {  
      "id":10,
      "name":"test"
   }
}

or for collection:

{  
   "data":[  
      {  
         "id":10,
         "name":"test"
      },
      {  
         "id":11,
         "name":"test12"
      }
   ]
}

[johannesschobel]

Does not work for JSONApiSerializer (also available in Fractal) as well.
When calling a GET route via Postman the results looks like this:

{
  "data": [
    {
      "type": "faqs",
      "id": "1",
      "attributes": {
        "name": "Progressive intangible analyzer",
        "title": "Reactive 4thgeneration encryption"
      },
      "links": {
        "self": "localhost/api/v1/faqs/1"
      }
    },
    {
      "type": "faqs",
      "id": "2",
      "attributes": {
        "name": "Phased systemic throughput",
        "title": "Team-oriented system-worthy encoding"
      },
      "links": {
        "self": "localhost/api/v1/faqs/2"
      }
    }
}

When watching the result for the same route within the auto-generated docs file, it looks like this:

[
    {
        "id": 1,
        "name": "Progressive intangible analyzer",
        "is_active": 1,
        "activated_at": "0000-00-00 00:00:00",
        "created_at": "2016-08-04 12:41:48",
        "updated_at": "2016-08-04 12:41:48",
        "translations": [
            {
                "id": 2,
                "faq_id": 1,
                "locale": "de",
                "title": "Extended 6thgeneration synergy",
                "question": "Perferendis ad rerum ut et voluptatem. Molestiae itaque animi corrupti itaque omnis.",
                "answer": "Amet officiis ut assumenda quo fugit aut. Dolorem repellat corporis maiores voluptate. Animi ullam beatae velit necessitatibus ut. Rerum qui cum tempore rem eligendi nemo voluptatum.",
                "created_at": "2016-08-04 12:41:48",
                "updated_at": "2016-08-04 12:41:48"
            },
            {
                "id": 1,
                "faq_id": 1,
                "locale": "en",
                "title": "Reactive 4thgeneration encryption",
                "question": "Nisi quia nihil veritatis autem magnam. Sunt incidunt expedita quo aperiam nihil ut. Consequatur atque totam non error dolore natus.",
                "answer": "Architecto exercitationem fugiat et omnis doloribus repellat non. Quo ratione aliquam veritatis vero sapiente quod. Eligendi tempora odit qui est quo.",
                "created_at": "2016-08-04 12:41:48",
                "updated_at": "2016-08-04 12:41:48"
            }
        ],
        "title": "Reactive 4thgeneration encryption",
        "question": "Nisi quia nihil veritatis autem magnam. Sunt incidunt expedita quo aperiam nihil ut. Consequatur atque totam non error dolore natus.",
        "answer": "Architecto exercitationem fugiat et omnis doloribus repellat non. Quo ratione aliquam veritatis vero sapiente quod. Eligendi tempora odit qui est quo."
    },
    {
        "id": 2,
        "name": "Phased systemic throughput",
        "is_active": 1,
        "activated_at": "0000-00-00 00:00:00",
        // ... and a lot more attributes here... 
    }
}

It looks like the Transformer is ignored for the output?!
Greetings