{"id":3445,"date":"2022-04-20T04:11:12","date_gmt":"2022-04-20T07:11:12","guid":{"rendered":"https:\/\/www.magenteiro.com\/blog\/?p=3445"},"modified":"2022-04-20T04:14:20","modified_gmt":"2022-04-20T07:14:20","slug":"como-adicionar-metodos-na-api-do-magento","status":"publish","type":"post","link":"https:\/\/www.magenteiro.com\/blog\/magento-2\/desenvolvimento-m2\/como-adicionar-metodos-na-api-do-magento\/","title":{"rendered":"Como adicionar m\u00e9todos na API do Magento"},"content":{"rendered":"\n

No artigo de hoje, mostrarei um exemplo b\u00e1sico de como podemos publicar o m\u00e9todo de uma classe nas APIs REST e SOAP do Magento 2.<\/p>\n\n\n\n

As APIs REST do Magento<\/a> est\u00e3o dispon\u00edveis em \/rest\/V1 em qualquer loja Magento 2. Boa parte destas APIs s\u00e3o expostas por m\u00f3dulos do pr\u00f3prio Magento e consumidas em diversas \u00e1reas da plataforma.<\/p>\n\n\n\n

Por\u00e9m, nada impede voc\u00ea de consumir estas APIs nas suas integra\u00e7\u00f5es<\/a>.<\/p>\n\n\n\n

Como os m\u00e9todos s\u00e3o expostos \u00e0 API<\/h2>\n\n\n\n

De forma resumida, o Magento espera que m\u00e9todos e classes expostos na API implementem classes do tipo interface<\/em> e sejam declarados em um arquivo webapi.xml<\/code>.<\/p>\n\n\n\n

Estes m\u00e9todos ter blocos de coment\u00e1rio que definem @param<\/code> e @return<\/code> a fim de informar o Magento os tipos de par\u00e2metros e retornos esperados.<\/p>\n\n\n\n

Quer ver um exemplo?<\/p>\n\n\n\n

M\u00e3o na massa em 5 minutos<\/h2>\n\n\n\n

No exemplo abaixo, criarei uma API simples que espera receber uma string<\/em> qualquer. Ela ser\u00e1 respons\u00e1vel por devolver o valor reverso desta mesma string. Ou seja, se passarmos abc<\/code> como par\u00e2metro, espero receber cba<\/code> como retorno. O objetivo aqui \u00e9 apenas mostrar como podemos expor um m\u00e9todo personalizado.<\/p>\n\n\n\n

Criando a interface (contrato de servi\u00e7o)<\/h3>\n\n\n\n
<?php\ndeclare(strict_types=1);\n\nnamespace Magenteiro\\StringApi\\Api;\n\/**\n * String API Interface\n *\/\ninterface StringApiInterface {\n    \/**\n     * Reverse a string\n     * @param string $string\n     *\n     * @return string\n     *\/\n    public function reverse(string $string): string;\n}<\/pre>\n\n\n\n
A primeira classe que criei, define o m\u00e9todo que ser\u00e1 exposto \u00e0 API (reverse). Os par\u00e2metros de entrada e sa\u00edda s\u00e3o informados nos coment\u00e1rios. Note que no meu exemplo, o tipo de par\u00e2metro de entrada e sa\u00edda \u00e9 do tipo string<\/code> e o nome do par\u00e2metro tamb\u00e9m foi definido como $string<\/code>. Bem criativo, n\u00e3o \u00e9 mesmo?<\/p>\n\n\n\n
Criando a classe e o m\u00e9todo que vamos expor na API<\/h3>\n\n\n\n
<?php\ndeclare(strict_types=1);\n\nnamespace Magenteiro\\StringApi\\Model;\n\nuse Magenteiro\\StringApi\\Api\\StringApiInterface;\n\nclass StringApi implements StringApiInterface\n{\n    \/**\n     * @inheritdoc\n     *\/\n    public function reverse(string $string): string\n    {\n        return strrev($string);\n    }\n}<\/pre>\n\n\n\n
Note que ela implementa nossa interface, e consequentemente \u00e9 obrigada a declarar o m\u00e9todo reverse<\/code>. A revers\u00e3o da string de entrada \u00e9 feita com o m\u00e9todo strrev<\/a> do pr\u00f3prio PHP e dispensa maiores explica\u00e7\u00f5es.<\/p>\n\n\n\n
Declarando a prefer\u00eancia da nossa interface<\/h3>\n\n\n\n
Agora devemos definir uma Preference<\/em> para nossa Interface. Preferences<\/em> n\u00e3o s\u00e3o usadas apenas para sobrescrever classes – como voc\u00ea viu no meu curso de cria\u00e7\u00e3o de m\u00f3dulos para Magento 2<\/a>. Elas tamb\u00e9m s\u00e3o usadas para definir a classe principal a ser instanciada quando uma interface \u00e9 injetada<\/a>.<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<config xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\" xsi:noNamespaceSchemaLocation=\"urn:magento:framework:ObjectManager\/etc\/config.xsd\">\n    <preference for=\"Magenteiro\\StringApi\\Api\\StringApiInterface\" type=\"Magenteiro\\StringApi\\Model\\StringApi\"\/>\n<\/config>\n<\/pre>\n\n\n\n
Definindo endpoint do nosso m\u00e9todo personalizado<\/h3>\n\n\n\n
Por fim, vamos criar o webapi.xml<\/code> e declarar o m\u00e9todo e servi\u00e7o que est\u00e1 sendo exposto. Al\u00e9m disso, tamb\u00e9m vamos especificar em qual URL ele ser\u00e1 servido e quem ter\u00e1 acesso \u00e0 ele.<\/p>\n\n\n\n
<?xml version=\"1.0\"?>\n<routes xmlns:xsi=\"http:\/\/www.w3.org\/2001\/XMLSchema-instance\"\n        xsi:noNamespaceSchemaLocation=\"urn:magento:module:Magento_Webapi:etc\/webapi.xsd\">\n    <route method=\"GET\" url=\"\/V1\/string\/reverse\">\n        <service class=\"Magenteiro\\StringApi\\Api\\StringApiInterface\" method=\"reverse\"\/>\n        <resources>\n            <resource ref=\"anonymous\"\/>\n        <\/resources>\n    <\/route>\n<\/routes>\n<\/pre>\n\n\n\n
A propriedade resource<\/code> definir\u00e1 o tipo de recurso que o cliente que est\u00e1 chamando precisa ter acesso. Os valores podem ser self<\/code>, anonymous<\/code>, ou um resource espec\u00edfico como Magento_Customer::group<\/code>. Veja a aula “Controllers e Permiss\u00f5es (ACL) na \u00e1rea administrativa” do Magento 2: O Curso<\/a> para mais detalhes.<\/p>\n\n\n\n
No nosso exemplo, informei o valor anonymous<\/code>. Ele permitir\u00e1 que qualquer pessoa, mesmo sem estar logada, tenha acesso ao nosso novo endpoint<\/em>.<\/p>\n\n\n\n
Testando nosso novo endpoint<\/h2>\n\n\n\n
Ap\u00f3s recompilar as classes (bin\/magento s:d:c<\/code>), podemos acessar nossaloja.com\/rest\/V1\/string\/reverse e passar nosso par\u00e2metro string<\/code>.<\/p>\n\n\n\n
Veja no v\u00eddeo abaixo como ficou.<\/p>\n\n\n\n

O nome do m\u00f3dulo que criaremos \u00e9 Magenteiro_StringApi<\/code>. N\u00e3o mostrarei abaixo a estrutura b\u00e1sica do m\u00f3dulo<\/a>, mas voc\u00ea pode conferir no link ao lado.<\/p>\n\n\n\n