Como retornar um objeto JSON com uma API REST personalizada no Magento 2?


14

Estou escrevendo uma demonstração personalizada da API REST; agora ele pode retornar números e seqüências de caracteres na minha demonstração, mas quero que ele retorne um objeto JSON como outras APIs REST.

Na minha demonstração, chamo a API do Magento 2 (ou seja, obter informações do cliente: http: //localhost/index.php/rest/V1/customers/1 ) com curl, e ela retorna uma string JSON:

"{\" id \ ": 1, \" group_id \ ": 1, \" default_billing \ ": \" 1 \ ", \" created_at \ ": \" 2016-12-13 14: 57: 30 \ " , \ "updated_at \": \ "2016-12-13 15:20:19 \", \ "created_in \": \ "Default Store View \", \ "email \": \ "75358050@qq.com \ ", \" firstname \ ": \" azol \ ", \" lastname \ ": \" young \ ", \" store_id \ ": 1, \" website_id \ ": 1, \" address \ ": [{ \ "id \": 1, \ "customer_id \": 1, \ "region \": {\ "region_code \": \ "AR \", \ "region \": \ "Arad \", \ "region_id \ ": 279}, \" region_id \ ": 279, \" country_id \ ": \" RO \ ", \" street \ ": [\" abc \ "], \" telephone \ ": \" 111 \ ", \" código postal \ ": \"1111 \ ", \" city \ ": \" def \ ", \" firstname \ ": \" azol \ ", \" lastname \ ": \" young \ ", \" default_billing \ ": true}], \ "disable_auto_group_change \": 0} "

A resposta é uma sequência JSON, mas todas as chaves possuem uma barra dentro. Eu sei que posso remover a barra str_replace, mas é uma maneira estúpida. Existe alguma outra maneira de retornar um objeto JSON sem barras nas chaves?

************ ATUALIZAÇÃO 2016.12.27 ************

Eu colei meu código de teste aqui:

   $method = 'GET';
    $url = 'http://localhost/index.php/rest/V1/customers/1';

    $data = [
        'oauth_consumer_key' => $this::consumerKey,
        'oauth_nonce' => md5(uniqid(rand(), true)),
        'oauth_signature_method' => 'HMAC-SHA1',
        'oauth_timestamp' => time(),
        'oauth_token' => $this::accessToken,
        'oauth_version' => '1.0',
    ];

    $data['oauth_signature'] = $this->sign($method, $url, $data, $this::consumerSecret, $this::accessTokenSecret);

    $curl = curl_init();

    curl_setopt_array($curl, [
        CURLOPT_RETURNTRANSFER => 1,
        CURLOPT_URL => $url,
        CURLOPT_HTTPHEADER => [
            'Authorization: OAuth ' . http_build_query($data, '', ','),
            'Content-Type: application/json'
        ], 
    ]);

    $result = curl_exec($curl);
    curl_close($curl);

    // this code has slash still
    //return stripslashes("hi i\" azol"); 

    // has slashes still
    //return stripcslashes("{\"id\":1,\"group_id\":1,\"default_billing\":\"1\",\"created_at\":\"2016-12-13 14:57:30\",\"updated_at\":\"2016-12-13 15:20:19\",\"created_in\":\"Default Store View\",\"email\":\"75358050@qq.com\",\"firstname\":\"azol\",\"lastname\":\"young\",\"store_id\":1,\"website_id\":1,\"addresses\":[{\"id\":1,\"customer_id\":1,\"region\":{\"region_code\":\"AR\",\"region\":\"Arad\",\"region_id\":279},\"region_id\":279,\"country_id\":\"RO\",\"street\":[\"abc\"],\"telephone\":\"111\",\"postcode\":\"1111\",\"city\":\"def\",\"firstname\":\"azol\",\"lastname\":\"young\",\"default_billing\":true}],\"disable_auto_group_change\":0}");

    // has slashes still
    //return json_encode(json_decode($result), JSON_UNESCAPED_SLASHES);

    // this code will throw and expcetion:
    // Undefined property: *****\*****\Model\Mycustom::$_response
    //return  $this->_response->representJson(json_encode($data));

    return $result;

Você tenta com return json_encode($result, JSON_UNESCAPED_SLASHES);?
Khoa TruongDinh

sim, eu tentei, ele lançará uma exceção, porque $ result é uma string
azol.young

Tente outra maneira: $json_string = stripslashes($result)ereturn json_decode($json_string, true);
Khoa TruongDinh

Respostas:


1

Podemos usar json_encodecom JSON_UNESCAPED_SLASHES:

json_encode($response, JSON_UNESCAPED_SLASHES);

oi, sim, eu fiz isso no meu código, mas ainda tem barra
azol.young

Você tentou com a stripslashes()função ou json_encode($str, JSON_UNESCAPED_SLASHES);?
Khoa TruongDinh

Leia minha resposta atualizada.
Khoa TruongDinh

1
Tente $ this -> _ response-> representJson (json_encode ($ data));
Pratik

Oi Khoa, obrigado! Eu tentei codificar "json_encode ($ response, JSON_UNESCAPED_SLASHES);" e stripslashes ("oi i \" azol ") ;, ainda tem barra .......
azol.young

1

Crie o ws.php no diretório raiz do magento 2 e cole o código abaixo no arquivo:

<?php
    use Magento\Framework\App\Bootstrap;
    require __DIR__ . '/app/bootstrap.php';
    $params = $_SERVER;
    $bootstrap = Bootstrap::create(BP, $params);


    function sign($method, $url, $data, $consumerSecret, $tokenSecret)
    {
        $url = urlEncodeAsZend($url);
        $data = urlEncodeAsZend(http_build_query($data, '', '&'));
        $data = implode('&', [$method, $url, $data]);
        $secret = implode('&', [$consumerSecret, $tokenSecret]);
        return base64_encode(hash_hmac('sha1', $data, $secret, true));
    }

    function urlEncodeAsZend($value)
    {
        $encoded = rawurlencode($value);
        $encoded = str_replace('%7E', '~', $encoded);
        return $encoded;
    }

    // REPLACE WITH YOUR ACTUAL DATA OBTAINED WHILE CREATING NEW INTEGRATION
    $consumerKey = 'YOUR_CONSUMER_KEY';
    $consumerSecret = 'YOUR_CONSUMER_SECRET';
    $accessToken = 'YOUR_ACCESS_TOKEN';
    $accessTokenSecret = 'YOUR_ACCESS_TOKEN_SECRET';

    $method = 'GET';
    $url = 'http://localhost/magento2/rest/V1/customers/1';

//
$data = [
    'oauth_consumer_key' => $consumerKey,
    'oauth_nonce' => md5(uniqid(rand(), true)),
    'oauth_signature_method' => 'HMAC-SHA1',
    'oauth_timestamp' => time(),
    'oauth_token' => $accessToken,
    'oauth_version' => '1.0',
];

$data['oauth_signature'] = sign($method, $url, $data, $consumerSecret, $accessTokenSecret);

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_RETURNTRANSFER => 1,
    CURLOPT_URL => $url,
    CURLOPT_HTTPHEADER => [
        'Authorization: OAuth ' . http_build_query($data, '', ',')
    ]
]);

$result = curl_exec($curl);
curl_close($curl);

echo $result;

$response = \Zend_Json::decode($result);
echo "<pre>";
print_r($response);
echo "</pre>";

Depois disso, execute este arquivo usando um link como http: //localhost/magento2/ws.php no navegador e verifique a saída.


1

Tentei usar o seguinte script para testar se recebo barras na mesma resposta da API:

<?php
// create a new cURL resource
$ch = curl_init();

// set URL and other appropriate options
curl_setopt($ch, CURLOPT_URL, "http://www.example.test/rest/all/V1/customers/12408");
curl_setopt($ch, CURLOPT_HEADER, false);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer oc34ouc8lvyvxcbn16llx7dfrjygdoh2', 'Accept: application/json']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// grab URL and pass it to the browser
$result = curl_exec($ch);

var_dump($result);

// close cURL resource, and free up system resources
curl_close($ch);

O que produz essa resposta (truncada pela função var_dump do PHP):

$ php -f apitest2.php 
/var/www/html/dfl/htdocs/apitest2.php:14:
string(1120) "{"id":12408,"group_id":13,"default_billing":"544","default_shipping":"544","created_at":"2018-05-24 08:32:59","updated_at":"2018-05-24 08:32:59","created_in":"Default Store View","email":"...

Como você pode ver, não há barras na minha resposta.

Então, sugiro que você tenha duas opções:

  • Investigue por que sua configuração cURL está retornando uma resposta com barras. Talvez tenha algo a ver com o uso de oauth? Parece que algo está pegando a resposta bruta do cURL e, em seguida, tentando fazer algo (como saída) e, no processo, adicionando as barras
  • Persista em encontrar uma maneira de remover as barras usando str_replaceou similar.

Depois de obter sua resposta sem barras, você pode usar a seguinte linha para forçar o PHP a converter a string em um objeto JSON:

$object = json_decode( $output, false, 512, JSON_FORCE_OBJECT);
Ao utilizar nosso site, você reconhece que leu e compreendeu nossa Política de Cookies e nossa Política de Privacidade.
Licensed under cc by-sa 3.0 with attribution required.