Retornando JSON de um Script PHP

877

Eu quero retornar JSON de um script PHP.

Eu apenas ecoo o resultado? Eu tenho que definir o Content-Typecabeçalho?

Scott Nicol
fonte

Respostas:

1604

Embora você normalmente esteja bem sem ele, você pode e deve definir o cabeçalho Content-Type:

<?PHP
$data = /** whatever you're serializing **/;
header('Content-Type: application/json');
echo json_encode($data);

Se eu não estiver usando uma estrutura específica, geralmente permito que alguns parâmetros de solicitação modifiquem o comportamento da saída. Pode ser útil, geralmente para solução rápida de problemas, não enviar um cabeçalho ou, às vezes, imprimir a carga útil dos dados para observá-lo (embora na maioria dos casos, isso não seja necessário).

timdev
fonte
9
apenas no caso: você deve usar header () comandos apenas em adição com o buffer de saída para evitar "cabeçalhos já enviou" advertências
Kevin
6
O arquivo php tem que ser codificados em UTF-8 sem BOM :)
Krzysztof Kalinowski
217
header('Content-type:application/json;charset=utf-8');
Timo Huovinen
14
@ Mikepote Na verdade, não acho que seja necessário ter o comando header no topo do arquivo PHP. Se você está cuspindo coisas inadvertidamente e ativando seu comando de cabeçalho, basta corrigir seu código porque está quebrado.
Halfstop 10/09/15
8
@KrzysztofKalinowski não, o arquivo PHP não precisa ser codificado em UTF-8. a saída DEVE ser codificada em UTF-8. Essas afirmações erradas não ajudam usuários não experientes a aprender como evitar que as coisas quebrem, mas ajudam a desenvolver mitos sobre eles e nunca aprendem qual o papel que as codificações desempenham nos fluxos e como elas funcionam.
Áxel Costas Pena 26/10
124

Uma parte completa do código PHP agradável e claro que retorna JSON é:

$option = $_GET['option'];

if ( $option == 1 ) {
    $data = [ 'a', 'b', 'c' ];
    // will encode to JSON array: ["a","b","c"]
    // accessed as example in JavaScript like: result[1] (returns "b")
} else {
    $data = [ 'name' => 'God', 'age' => -1 ];
    // will encode to JSON object: {"name":"God","age":-1}  
    // accessed as example in JavaScript like: result.name or result['name'] (returns "God")
}

header('Content-type: application/json');
echo json_encode( $data );
aesede
fonte
44

De acordo com o manualjson_encode do método, pode retornar uma não-string ( false ):

Retorna uma sequência codificada em JSON em caso de sucesso ou FALSEfalha.

Quando isso acontece echo json_encode($data), gera a cadeia vazia, que é JSON inválida .

json_encodepor exemplo, falhará (e retornará false) se seu argumento contiver uma sequência não UTF-8.

Esta condição de erro deve ser capturada no PHP, por exemplo:

<?php
header("Content-Type: application/json");

// Collect what you need in the $data variable.

$json = json_encode($data);
if ($json === false) {
    // Avoid echo of empty string (which is invalid JSON), and
    // JSONify the error message instead:
    $json = json_encode(["jsonError" => json_last_error_msg()]);
    if ($json === false) {
        // This should not happen, but we go all the way now:
        $json = '{"jsonError":"unknown"}';
    }
    // Set HTTP response status code to: 500 - Internal Server Error
    http_response_code(500);
}
echo $json;
?>

Então, o final do recebimento deve estar ciente de que a presença da propriedade jsonError indica uma condição de erro, que deve ser tratada adequadamente.

No modo de produção, pode ser melhor enviar apenas um status de erro genérico ao cliente e registrar as mensagens de erro mais específicas para investigação posterior.

Leia mais sobre como lidar com erros JSON na documentação do PHP .

trincot
fonte
2
Não há charsetparâmetro para JSON; consulte a nota no final de tools.ietf.org/html/rfc8259#section-11 : "Nenhum parâmetro 'charset' está definido para este registro. Adicionar um realmente não afeta os destinatários compatíveis". (JSON deve ser transmitida como UTF-8 por tools.ietf.org/html/rfc8259#section-8.1 , de modo que especifica que é codificado como UTF-8 é um bit redundante.)
Patrick escuro
1
Obrigado por destacar isso, @PatrickDark. charsetParâmetro redundante removido da cadeia de cabeçalho HTTP.
trincot
38

Tentar json_encode para codificar os dados e defina o tipo de conteúdo com header('Content-type: application/json');.

thejh
fonte
15

Defina o tipo de conteúdo com header('Content-type: application/json');e, em seguida, faça eco aos seus dados.

Brad Mace
fonte
12

Também é bom definir a segurança do acesso - basta substituir * pelo domínio que você deseja alcançar.

<?php
header('Access-Control-Allow-Origin: *');
header('Content-type: application/json');
    $response = array();
    $response[0] = array(
        'id' => '1',
        'value1'=> 'value1',
        'value2'=> 'value2'
    );

echo json_encode($response); 
?>

Aqui estão mais exemplos disso: como ignorar o Access-Control-Allow-Origin?

Dr. Aaron Dishno
fonte
7
<?php
$data = /** whatever you're serializing **/;
header("Content-type: application/json; charset=utf-8");
echo json_encode($data);
?>
Joyal
fonte
Qual é a diferença declarando o conjunto de caracteres no cabeçalho? Por favor, explique, obrigado.
Sanxofon 22/11/19
6

Como dito acima:

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

fará o trabalho. mas lembre-se de que:

  • O Ajax não terá problemas para ler o json, mesmo que esse cabeçalho não seja usado, exceto se o seu json contiver algumas tags HTML. Nesse caso, você precisa definir o cabeçalho como application / json.

  • Verifique se o seu arquivo não está codificado no UTF8-BOM. Este formato adiciona um caractere na parte superior do arquivo, para que a chamada do cabeçalho () falhe.

Tom Ah
fonte
4

Uma função simples para retornar uma resposta JSON com o código de status HTTP .

function json_response($data=null, $httpStatus=200)
{
    header_remove();

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

    http_response_code($httpStatus);

    echo json_encode($data);

    exit();
}
Dan
fonte
1
header_remove, e definir explicitamente a resposta http é uma boa ideia; embora definir status e http_response pareça redundante. Também pode querer adicionar uma exitdeclaração ao final. Eu combinei sua função com @trincot é: stackoverflow.com/a/35391449/339440
Stephen R
Obrigado pela sugestão. Acabei de atualizar a resposta.
19419 Dan
3

A resposta para sua pergunta está aqui ,

Diz.

O tipo de mídia MIME para o texto JSON é application / json.

portanto, se você definir o cabeçalho para esse tipo e gerar sua sequência JSON, ela funcionará.

Codemwnci
fonte
1

Sim, você precisará usar eco para exibir a saída. Mimetype: application / json

Nev Stokes
fonte
1

Se você precisar obter o json do php enviando informações personalizadas, você pode adicioná-las header('Content-Type: application/json');antes para imprimir qualquer outra coisa, para que você possa imprimir o seu custoecho '{"monto": "'.$monto[0]->valor.'","moneda":"'.$moneda[0]->nombre.'","simbolo":"'.$moneda[0]->simbolo.'"}';

jacr1614
fonte
1

Se você consultar um banco de dados e precisar do conjunto de resultados no formato JSON, isso poderá ser feito da seguinte maneira:

<?php

$db = mysqli_connect("localhost","root","","mylogs");
//MSG
$query = "SELECT * FROM logs LIMIT 20";
$result = mysqli_query($db, $query);
//Add all records to an array
$rows = array();
while($row = $result->fetch_array()){
    $rows[] = $row;
}
//Return result to jTable
$qryResult = array();
$qryResult['logs'] = $rows;
echo json_encode($qryResult);

mysqli_close($db);

?>

Para obter ajuda na análise do resultado usando o jQuery, consulte este tutorial .

Eyece
fonte
1

Este é um script PHP simples para retornar o sexo feminino e o ID do usuário, pois o valor json será qualquer valor aleatório quando você chamar o script json.php.

Espero que esta ajuda obrigado

<?php
header("Content-type: application/json");
$myObj=new \stdClass();
$myObj->user_id = rand(0, 10);
$myObj->male = rand(0, 5);
$myObj->female = rand(0, 5);
$myJSON = json_encode($myObj);
echo $myJSON;
?>
Bidyashish Kumar
fonte
O tipo de mídia MIME para o texto JSON é application / json
AA
0

Uma maneira fácil de formatar seus objetos de domínio para JSON é usar o Marshal Serializer . Em seguida, passe os dados json_encodee envie o cabeçalho do tipo de conteúdo correto para suas necessidades. Se você estiver usando uma estrutura como o Symfony, não precisará definir manualmente os cabeçalhos. Lá você pode usar o JsonResponse .

Por exemplo, o tipo de conteúdo correto para lidar com Javascript seria application/javascript.

Ou, se você precisar oferecer suporte a alguns navegadores bastante antigos, o mais seguro seria text/javascript.

Para todos os outros fins, como um aplicativo móvel, use application/jsoncomo o Tipo de conteúdo.

Aqui está um pequeno exemplo:

<?php
...
$userCollection = [$user1, $user2, $user3];

$data = Marshal::serializeCollectionCallable(function (User $user) {
    return [
        'username' => $user->getUsername(),
        'email'    => $user->getEmail(),
        'birthday' => $user->getBirthday()->format('Y-m-d'),
        'followers => count($user->getFollowers()),
    ];
}, $userCollection);

header('Content-Type: application/json');
echo json_encode($data);
Kingson
fonte
0

Sempre que você estiver tentando retornar a resposta JSON para API, verifique se você possui cabeçalhos adequados e também retorne dados JSON válidos.

Aqui está o script de amostra que ajuda você a retornar a resposta JSON da matriz PHP ou do arquivo JSON.

Script PHP (código):

<?php

// Set required headers
header('Content-Type: application/json; charset=utf-8');
header('Access-Control-Allow-Origin: *');

/**
 * Example: First
 *
 * Get JSON data from JSON file and retun as JSON response
 */

// Get JSON data from JSON file
$json = file_get_contents('response.json');

// Output, response
echo $json;

/** =. =.=. =.=. =.=. =.=. =.=. =.=. =.=. =.=. =.=. =.  */

/**
 * Example: Second
 *
 * Build JSON data from PHP array and retun as JSON response
 */

// Or build JSON data from array (PHP)
$json_var = [
  'hashtag' => 'HealthMatters',
  'id' => '072b3d65-9168-49fd-a1c1-a4700fc017e0',
  'sentiment' => [
    'negative' => 44,
    'positive' => 56,
  ],
  'total' => '3400',
  'users' => [
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'rayalrumbel',
      'text' => 'Tweet (A), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'mikedingdong',
      'text' => 'Tweet (B), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'ScottMili',
      'text' => 'Tweet (C), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
    [
      'profile_image_url' => 'http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg',
      'screen_name' => 'yogibawa',
      'text' => 'Tweet (D), #HealthMatters because life is cool :) We love this life and want to spend more.',
      'timestamp' => '{{$timestamp}}',
    ],
  ],
];

// Output, response
echo json_encode($json_var);

Arquivo JSON (JSON DATA):

{
    "hashtag": "HealthMatters", 
    "id": "072b3d65-9168-49fd-a1c1-a4700fc017e0", 
    "sentiment": {
        "negative": 44, 
        "positive": 56
    }, 
    "total": "3400", 
    "users": [
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "rayalrumbel", 
            "text": "Tweet (A), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }, 
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "mikedingdong", 
            "text": "Tweet (B), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }, 
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "ScottMili", 
            "text": "Tweet (C), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }, 
        {
            "profile_image_url": "http://a2.twimg.com/profile_images/1285770264/PGP_normal.jpg", 
            "screen_name": "yogibawa", 
            "text": "Tweet (D), #HealthMatters because life is cool :) We love this life and want to spend more.", 
            "timestamp": "{{$timestamp}}"
        }
    ]
}

Screeshot JSON:

insira a descrição da imagem aqui

Neeraj Singh
fonte
-1

Você pode usar esta pequena biblioteca PHP . Ele envia os cabeçalhos e fornece um objeto para usá-lo facilmente.

Parece que:

<?php
// Include the json class
include('includes/json.php');

// Then create the PHP-Json Object to suits your needs

// Set a variable ; var name = {}
$Json = new json('var', 'name'); 
// Fire a callback ; callback({});
$Json = new json('callback', 'name'); 
// Just send a raw JSON ; {}
$Json = new json();

// Build data
$object = new stdClass();
$object->test = 'OK';
$arraytest = array('1','2','3');
$jsonOnly = '{"Hello" : "darling"}';

// Add some content
$Json->add('width', '565px');
$Json->add('You are logged IN');
$Json->add('An_Object', $object);
$Json->add("An_Array",$arraytest);
$Json->add("A_Json",$jsonOnly);

// Finally, send the JSON.

$Json->send();
?>
Alexis Paques
fonte