介绍
对于任何成功的平台，至关重要的是要紧跟最新功能并提供它们以在市场中竞争。 公开适用于您平台的API是允许与第三方系统集成的重要功能之一，从而为更大的社区打开了大门。 Magento是最成功的电子商务平台之一，提供了许多有用的功能和实用程序，证明了它是真正的企业级框架。
为您的资源公开API在许多方面都是有益的。 最明显的原因之一是，借助XML-RPC / SOAP之类的协议，它可以使资源在不同的平台上可用，从而使它们在平台上独立，这使您可以以简化的方式公开资源。 我们将使用SOAP作为自定义模块。
在本教程中，我们将创建一个自定义模块“ Customapimodule”。 我假设您熟悉Magento中的基本模块创建过程。 这是一篇很好的文章，解释了自定义模块创建的基础。
文件设置概览
以下是所需设置所需的文件列表：
- app / etc / modules / Envato_All.xml：这是用于启用我们的自定义模块的文件。
- app / code / local / Envato / Customapimodule / etc / config.xml：这是一个模块配置文件。
- app / code / local / Envato / Customapimodule / etc / api.xml：这是一个声明我们模块提供的API的文件。
- app / code / local / Envato / Customapimodule / etc / wsdl.xml：在此文件中，我们将根据WSDL的约定定义API方法。
- app / code / local / Envato / Customapimodule / Helper / Data.php：这是Magento翻译系统使用的文件。
- app / code / local / Envato / Customapimodule / Model / Product / Api.php：这是一个模型文件，可实现我们API方法的逻辑。
- app / code / local / Envato / Customapimodule / Model / Product / Api / V2.php：这是支持Magento v2 API的文件。
自定义模块创建：设置文件
首先，我们将创建一个模块启动器文件。 创建一个文件“ app / etc / modules / Envato_All.xml”，并将以下内容粘贴到该文件中。 我们使用“ Envato”作为模块名称空间，使用“ Customapimodule”作为模块名称。 默认情况下，它将启用我们的“ Customapimodule”模块。
true
local
接下来，我们需要创建一个模块配置文件。 创建“ app / code / local / Envato / Customapimodule / etc / config.xml”，并将以下内容粘贴到该文件中。
1.0
Envato_Customapimodule_Model
Envato_Customapimodule_Helper
这里没什么好想的-根据Magento约定，我们仅声明了“ Model”和“ Helper”类。
继续，创建“ app / code / local / Envato / Customapimodule / etc / api.xml”，并将以下内容粘贴到该文件中。 “ api.xml”文件用于声明模块公开的API方法。
customapimodule/product_api
Demo Custommoduleapi API
customapimodule/product
List of products
items
customapimodule_product
customapimoduleProduct
Products
5
Product data
我们将从
在我们的示例中，我们只声明了一个名为
此外，
在文件底部，您可以看到我们已经声明了一个单独的
目前，支持两个版本的Magento API，即v1和v2，您可以使用它们创建和公开API。 在我们的示例中，我们将看到两种方法。
接下来，让我们创建“ app / code / local / Envato / Customapimodule / etc / wsdl.xml”文件，然后粘贴以下内容。
List of products
“ wsdl.xml”文件用于根据SOAP语法定义API方法定义。 在本教程的上下文中，我们将在此文件中看到一些重要的标记。
首先，我们定义了“ fieldInfo”复杂类型，其中包含两个元素：“ entity_id”和“ name”。 此外，我们定义了“ fieldInfoArray”复杂类型，它是从“ fieldInfo”复杂类型派生的。 它是“ fieldInfo”复杂类型的数组。
简单来说，我们已经定义了对象属性，这些属性将在API方法调用的响应中返回。 就我们而言，我们将返回一系列产品。 数组的每个项目将具有两个属性：产品的“ entity_id”和“ name”。 您可以根据需要定义更多属性。
接下来，在
接下来，我们需要创建“ app / code / local / Envato / Customapimodule / Helper / Data.php”文件，以确保Magento的翻译系统正常运行。 它几乎是一个空文件，但应按照约定放在那里！
接下来，让我们创建一个模型文件“ app / code / local / Envato / Customapimodule / Model / Product / Api.php”。
getCollection()
->addAttributeToSelect('*')
->setOrder('entity_id', 'DESC')
->setPageSize(5);
foreach ($products as $product) {
$arr_products[] = $product->toArray(array('entity_id', 'name'));
}
return $arr_products;
}
} 回想一下，在前面的“ api.xml”中，我们定义了一个由
在这种方法中，我们仅获取五个最新产品，并遍历每个项目以准备具有属性“ entity_id”和“ name”的产品数组。 因此，现在您可能应该了解在“ wsdl.xml”中创建“复杂类型”的原因！
此外，我们还需要创建一个模型文件来支持Magento v2 API。 让我们创建一个包含以下内容的模型文件“ app / code / local / Envato / Customapimodule / Model / Product / Api / v2.php”。
如您所见，它只是扩展了先前在“ app / code / local / Envato / Customapimodule / Model / Product / Api.php”文件中定义的模型类。
就自定义API实现而言，就文件设置而言就是这样。 如果您感到好奇，请从后端启用模块并清除缓存。 现在，当您访问http：// yourmagentostore / api / v2_soap？wsdl = 1页面时，您应该会看到我们的方法“ customapimoduleProductList”与其他API一起列出了！
在下一部分中，我们将继续学习如何创建API用户和API角色，当然，以及如何使用本教程中定义的自定义API方法！
翻译自: https://code.tutsplus.com/tutorials/create-a-custom-api-in-magento-part-one--cms-23785