Laravel 6.2 response()->json();でContent-Type textが返る

Question

前提・実現したいこと

APIでJsonレスポンスを返すように作成したのですが、
公式のドキュメントを見たところ、下記の通りでした。

readoubleに書いてあったこと

return response()->json([
    'name' => 'Abigail',
    'state' => 'CA'
]);

追記-実行環境です

$ php -v
PHP 7.2.23 (cli) (built: Sep 25 2019 07:38:48) ( NTS )
Copyright (c) 1997-2018 The PHP Group
Zend Engine v3.2.0, Copyright (c) 1998-2018 Zend Technologies

$ rpm -qa | grep php
php72-runtime-2.0-1.el7.remi.x86_64
php72-php-7.2.23-1.el7.remi.x86_64
php-cli-7.2.23-1.el7.remi.x86_64
php-gd-7.2.23-1.el7.remi.x86_64
php72-php-json-7.2.23-1.el7.remi.x86_64
php72-php-cli-7.2.23-1.el7.remi.x86_64
php72-2.0-1.el7.remi.x86_64
php-json-7.2.23-1.el7.remi.x86_64
php-7.2.23-1.el7.remi.x86_64
php-mbstring-7.2.23-1.el7.remi.x86_64
php-xml-7.2.23-1.el7.remi.x86_64
php-pdo-7.2.23-1.el7.remi.x86_64
php-pecl-zip-1.15.5-1.el7.remi.7.2.x86_64
php72-php-common-7.2.23-1.el7.remi.x86_64
php-common-7.2.23-1.el7.remi.x86_64
php-devel-7.2.23-1.el7.remi.x86_64
php-pecl-mcrypt-1.0.3-1.el7.remi.7.2.x86_64

POSTMANで確認したところ、Content-Type textで返却されました。

試したこと

$json = json_encode($response);
header('Content-Type: application/json');
echo $json;

上記だとJson形式で返却されました。

response()->json();
は上手く動いていないのでしょうか？

API開発をされている方どのようにされているか教えていただけると幸いです。

宜しくお願い致します。

Answer 1

私はいつもこの書き方でContent-Type: application/jsonになります。
普段は、REST Clientで確認していますが、先ほどPOSTMANやcURLで確認しても、jsonになりました。

        $data_json = [
            'name' => 'Abigail',
            'state' => 'CA'
        ];

        return response()->json(
            $data_json,
            200,
            [],
            JSON_UNESCAPED_UNICODE
        );

バージョンはこんな感じです。Laravel5系でも動いていました。

PHP: 7.3.6
Laravel: 6.0.4
Composer: 1.9.0

Comments

[larachan]

お忙しいところ、試して頂きありがとうございます。
頂いた以下のソースで試してみました。
return response()->json(
[ 'name' => 'Abigail',
'state' => 'CA'
],
200,
[],
JSON_UNESCAPED_UNICODE
);
がJson形式では返却されなかったです。
phpのバージョン関係あるのですかね？
一旦バージョン上げてみて再度確認してみます。

Answer 2

Symfony HTTP Foundation の JsonResponse のソースを読んでみると以下のようになっております。

    /**
     * Updates the content and headers according to the JSON data and callback.
     *
     * @return $this
     */
    protected function update()
    {
        if (null !== $this->callback) {
            // Not using application/javascript for compatibility reasons with older browsers.
            $this->headers->set('Content-Type', 'text/javascript');

            return $this->setContent(sprintf('/**/%s(%s);', $this->callback, $this->data));
        }

        // Only set the header when there is none or when it equals 'text/javascript' (from a previous update with callback)
        // in order to not overwrite a custom definition.
        if (!$this->headers->has('Content-Type') || 'text/javascript' === $this->headers->get('Content-Type')) {
            $this->headers->set('Content-Type', 'application/json');
        }

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

明示的に Content-Type ヘッダがセットされていなければ

$this->headers->set('Content-Type', 'application/json');

が自動的に呼ばれるはずですが，ミドルウェアで何か細工をしていたりしませんかね？ header 関数だと正常に動き，フレームワークの機構に乗ると失敗するということは Laravel レイヤでのミドルウェア が非常に怪しいです。 Nginx 等の Web サーバは逆に問題ないと思います。

またミドルウェアは直接自分で登録しなくても， サービスプロバイダからの登録も可能 なので，品質の悪いパッケージをインストールしていると自動実行されるそれのサービスプロバイダが問題を引き起こしている可能性もあります。

Comments

[larachan]

Kernel.phpにおいて、
protected $middlewareGroups = [
・・・
'api' => [
'throttle:60,1',
'bindings',
\App\Http\Middleware\RequireJson::class,

],
];
こちらのMidlewareのみが呼ばれる認識でしたが、、、
protected $middleware = [
内に過去にbladeを作成していた際にXSS対策として
$response->header('Content-Type', 'charset=UTF-8');
を付随する処理を記載してました。
削除したところ問題なくJsonレスポンスが返却されました！
APIではprotected $middleware = [
はルーティングで指定しないと呼ばれない認識でしたが、そうじゃあないんですね。。
この問題を解決して頂きありがとうございました！

[larachan]

回答頂いた方皆さんありがとうございました！

Answer 3

何らかの問題があってコントローラーが値を返すところまで処理が到達していないパターンではないでしょうか。

何らかの問題とは例えば

• ルート定義にないリクエストを送っている(パスを間違えたとかメソッドが違うとか)
• 認証ミドルウェアを使っていて認証に失敗している

などです。

このとき、response()->json(...)でjsonを返そうとしているとLaravelが知る由はなく、返却内容はリクエストのAcceptヘッダで決まります。Acceptヘッダがなければデフォルトのtext/htmlになります。

レスポンスのボディでエラー表示が返っているはずなので、中身を見るといいかもしれません。

Comments

[larachan]

遅くなりました。
ルーティングに関してはRoute::resourceを使用し、HTTPメソッドはGETで試しております。
認証のMidlewareは呼び出していません。
Acceptヘッダがなかったので、Midlewareを作成し、
$request->headers->set('Accept','application/json');
上記の形で付与してみましたが、上手く行きませんでした。。。
レスポンスボディはエラーは特に無いので、行き詰まっております。。

[crhg]

ここでいう「リクエストのAcceptヘッダ」はLaravelの側の話ではなく、クライアントから送られてくるもののことを言っています。POSTMANならHeadersタブで設定できます。

レスポンスにエラーはないということですが、具体的にはどんな物が返っているのでしょう。

[larachan]

POSTMANのヘッダーは設定済みでした。
CODEを確認すると下記のリクエストを投げています。
GET /api/パス HTTP/1.1
Host: ipアドレス
Content-Type: application/json

レスポンスボディは以下です。

{"name":"Abigail","state":"CA"}

レスポンスヘッダーは以下になります。
Server：Apache
X-Powered-By：PHP/7.2.26
Cache-Control：no-cache, private
X-RateLimit-Limit：60
X-RateLimit-Remaining：59
X-Frame-Options：DENY
Content-Length：31
Keep-Alive：timeout=5, max=99
Connection：Keep-Alive
Content-Type：charset=UTF-8
以上、宜しくお願い致します。

[crhg]

レスポンスのボディにコントローラで設定するはずの値が入っているので処理はコントローラまでは来てそうです。LaravelはContent-typeヘッダについては基本的にフレームワークが面倒を見てくれるので何もしなければちゃんと設定されるはずなのですが。content-typeがcharset岳になっているのもかなりおかしいです。これ以上は他の部分のプログラムも示されないと追いかけるのは難しいです。

[larachan]

レスポンスヘッダーのContent-Type UTF-8は自分もおかしいと思いました。
再現性がないので、しばらくechoで対応します。。

Answer 4

PHPの基本仕様ですね、それ

header('Content-Type: application/json');

MIME情報を付与しないと、PHPファイルはtext/html形式としか認識しないので、JSONをうまく処理できません。これはAjax処理するときに、初心者が皆陥る罠としても知られています。また、そのヘッダを付与するときは必ずUTF-8に指定しておいた方がいいですよ。JSONはUTF-8以外の動作を保障してませんので。

JSON リクエストとレスポンス

Comments

[mpyw]

Laravel およびベースとなっている Symfony フレームワークがその部分を隠蔽して実行してくれるはずが、どういうわけか動いていないようだ、という趣旨の質問だと思います。

[larachan]

mpywさん
おっしゃる通りです。
今はechoで対応してますが。。。

[FKM]

最後にexit;で閉じてもだめですか？
https://michimani.net/post/php-return-json-responce-in-laravel-project/
あるいは.htaccessで特別な制御をしている可能性とか？最後で質問者が、.htaccessでの制御を忘れていたとひとこと加えているという例です。
https://laracasts.com/discuss/channels/laravel/laravel-return-texthtml-instead-of-applicationjson?page=1（英語フォーラム）

[mpyw]

いやむしろ閉じると正しく動かないですね… exit するとそこから後の処理は register_shutdown_function 関数で登録された処理しか動かなくなりますね。PSR-7 と似た形式のレスポンスオブジェクトが response()->json() の呼び出しによって作られ，カーネルがレスポンスを送信する直前にヘッダー送信およびレスポンスの文字列化処理が行われるはずです。

[FKM]

だとすると、これと同じ現象でしょうか？これも同じAPIで試しているようです。
https://stackoverflow.com/questions/42837126/laravel-return-text-html-and-not-json

その中で有効そうな回答（8人の評価）があり、
Laravel provides modify header information using Response class.
訳すると、LaravelはResponseクラスを使用することでヘッダ情報の変更を適用できます。
Try this way in your controller :
コントローラ設定をこの方法で試してみてください。とあります。

$contents = View::make('embedded')->with('foo', $foo);
$response = Response::make($contents, $statusCode);
$response->header('Content-Type', 'text/plain');
return $response;

Responseクラスを使用していないか、あるいは適用されていない、そもそもの設定がされていない可能性も考えられます。