Cursos Magento

Tutorial: Módulo para customizar a API do Magento 2

,

03 de abril de 2018

Magento 2 - Customizando API

No Magento 2 vemos muito mais poder de API do que o Magento 1 com seus novos endpoints, e isso deixa ele ainda mais poderoso para manipulação. Mas não há como ter todas as funcionalidades nativas, e por isso eu escrevi este tutorial.

Para saber sobre API’s do Magento 1, consulte este outro artigo com exemplos de uso da API Magento, ou veja tudo sobre customização de API Soap Magento 1 na seção 9 do curso de criação de módulos e desenvolvimento backend para Magento 1.9.

Caso queira saber como consumir a API do Magento 2, você também pode ler o artigo já postado, chamado 3 Exemplos de como usar a API do Magento 2caso queira verificar o módulo criado abaixo basta acessar ele em meu Github.

Base do módulo

Como expliquei no artigo Gerador de módulos para Magento 2, vamos utilizar o Magerun 2 para gerar a base do nosso módulo, usando o comando:

Você também pode baixar um módulo base Magento 2 aqui no Magenteiro.

Depois do nosso módulo criado e ativado vamos começar o core do módulo.

Configuração da API

Para adicionar a função de API em nosso módulo vamos precisar adicionar apenas dois arquivos: o webapi.xml; e di.xml. No primeiro arquivo vamos configurar a API, e no segundo a interface que vai ser utilizada pelo nosso método.

etc/webapi.xml

Na tag  resource especificamos quais são os requerimentos do usuário para ter acesso a essa API. As opções possíveis são anonymous ou Magento (como é utilizado em Magento_Catalog::products ou Magento_Customer::group), definimos como anonymous para utilizar como um usuário anônimo.

etc/di.xml

No di.xml vamos apenas definir qual via ser a interface que deverá ser utilizada.

Api/HelloInterface.php

Model/Hello.php

Com nosso módulo pronto vamos acessar a URL http://localhost/rest/V1/hello/name/Rafael para ver a mensagem abaixo:

Magento 2 Api customizada

Espero que tenha gostado assim como eu gostei de fazer esse tutorial para vocês. Embora simples, mostra como é fácil criar um endpoint no Magento 2.

Artigo Original: Tutorial Módulo para customizar a API do Magento 2

 

Faça como  o Rafael e contribua você também com um artigo para o Magenteiro – O melhor portal nacional sobre Magento, com cursos, artigos e tutoriais.

Rafael Corrêa Gomes

Rafael Corrêa Gomes

Sr. Software Engineer em Redstage Magento Partner
Parte do Core Team do Magento 2, um dos organizadores do primeiro Meetup Magento oficial da América do Sul, 3 certificações Magento, mais de 15500 desenvolvedores Magento usando suas ferramentas, além de contribuir para projetos open source de empresas como Google, Facebook, Github, Twitter e etc..
Rafael Corrêa Gomes

Últimos posts por Rafael Corrêa Gomes (exibir todos)

Assuntos: | | |
Comentários