Regression: @responce ignored for all methods except GET

[LastDragon-ru]

After #279 is not possible to use @responce with POST - all examples in my docs died :( Is this PR is really needed? How can I fix my docs?

[shalvah]

The PR was needed because it was not part of the plan for the package to actually call non-GET routes. It led to unsuspecting side effects like deleting stuff in the database. What we should do is separate the @response annotation parsing from the actual API calls. I'll try to fix this later today.

[shalvah]

Tagged a new release (2.1.3) which should fix this.

[LastDragon-ru]

@shalvah, thank you for fix :) Unfortunately the json is not formatted

Seems need to replace this code (+ same for transformed responce)

if ($docblockResponse) {
            // we have a response from the docblock ( @response )
            $response = $docblockResponse;
            $showresponse = true;
            $content = $response->getContent();
        }

to

if ($docblockResponse) {
            // we have a response from the docblock ( @response )
            $response = $docblockResponse;
            $showresponse = true;
            if ($response->headers->get('Content-Type') === 'application/json') {
                $content = json_decode($response->getContent(), JSON_PRETTY_PRINT);
            } else {
                $content = $response->getContent();
            }
        }

And seems json will be formatted properly.

Probably will be good to extract this code to separate method

if ($response->headers->get('Content-Type') === 'application/json') {
                $content = json_decode($response->getContent(), JSON_PRETTY_PRINT);
            } else {
                $content = $response->getContent();
            }

PS: I try to create a PR later on this week.

[LastDragon-ru]

Or (but I have not tested it properly..)

    /**
     * @param  \Illuminate\Routing\Route $route
     * @param array $bindings
     * @param bool $withResponse
     *
     * @return array
     */
    public function processRoute($route, $bindings = [], $headers = [], $withResponse = true)
    {
        $routeDomain = $route->domain();
        $routeAction = $route->getAction();
        $routeGroup = $this->getRouteGroup($routeAction['uses']);
        $routeDescription = $this->getRouteDescription($routeAction['uses']);
        $showresponse = null;

        // set correct route domain
        $headers[] = "HTTP_HOST: {$routeDomain}";
        $headers[] = "SERVER_NAME: {$routeDomain}";

        $content = '';
        $response = null;
        $docblockResponse = $this->getDocblockResponse($routeDescription['tags']);
        if ($docblockResponse) {
            // we have a response from the docblock ( @response )
            $response = $docblockResponse;
            $showresponse = true;
        }
        if (! $response) {
            $transformerResponse = $this->getTransformerResponse($routeDescription['tags']);
            if ($transformerResponse) {
                // we have a transformer response from the docblock ( @transformer || @transformercollection )
                $response = $transformerResponse;
                $showresponse = true;
            }
        }
        if (! $response && $withResponse) {
            try {
                $response = $this->getRouteResponse($route, $bindings, $headers);
            } catch (\Exception $e) {
                dump("Couldn't get response for route: ".implode(',', $this->getMethods($route)).'] '.$route->uri().'', $e);
            }
        }

        if ($response) {
            if ($response->headers->get('Content-Type') === 'application/json') {
                $content = json_decode($response->getContent(), JSON_PRETTY_PRINT);
            } else {
                $content = $response->getContent();
            }
        }
        
        return $this->getParameters([
            'id' => md5($this->getUri($route).':'.implode($this->getMethods($route))),
            'resource' => $routeGroup,
            'title' => $routeDescription['short'],
            'description' => $routeDescription['long'],
            'methods' => $this->getMethods($route),
            'uri' => $this->getUri($route),
            'parameters' => [],
            'response' => $content,
            'showresponse' => $showresponse,
        ], $routeAction, $bindings);
    }

[shalvah]

Aw, shucks. Yeah, I see that. I can fix it later today, or would you like me to assign this issue to you? @LastDragon-ru

[LastDragon-ru]

@shalvah, No, please fix it :) (actually, I never used @transformer, but I hope my latest code will work in this case too)

[shalvah]

This should be fixed in #321 (released in 2.1.4)