# Magento2创建API

**URL:** https://forum.magentochina.org/t/magento2%E5%88%9B%E5%BB%BAapi/374
**Category:** Magento 2.X
**Tags:** 开发, 教程, api
**Created:** [2018 年4 月 23 日 06:39 UTC](https://forum.magentochina.org/t/magento2%E5%88%9B%E5%BB%BAapi/374 "2018-04-23T06:39:52Z")
**Posts on this page:** 1
**Page:** 1

<div class="post-metadata">

### 作者： ![Shuai](https://forum.magentochina.org/user_avatar/forum.magentochina.org/shuai/32/3_2.png) [@Shuai](https://forum.magentochina.org/u/Shuai)
#### 发布日期： [2018 年4 月 23 日 06:39 UTC](https://forum.magentochina.org/t/magento2%E5%88%9B%E5%BB%BAapi/374/1 "2018-04-23T06:39:52Z")

</div>

如果您想阅读完整的教程请点击查看:

> [@Magento2模块开发中文教程索引](https://forum.magentochina.org/t/Magento2%E6%A8%A1%E5%9D%97%E5%BC%80%E5%8F%91%E4%B8%AD%E6%96%87%E6%95%99%E7%A8%8B%E7%B4%A2%E5%BC%95/36):
>
> 本文翻译自mageplaza的Magento2模块开发教程,而且正在翻译中. 翻译也是非常好的学习方式，希望下列表中还有我们没有翻译，而你又想分享的内容,请发表文章之后，在下面附上地址。 如果觉得本站翻译得内容对您有帮助，又没有时间帮助翻译回馈社区.请打赏我们，您的支持是我们的动力: 转载说明:非常欢迎转载，但是必须保证文章的完整性并附上原文地址和翻译原文的地址，保证阅读者不会产生歧义. 目录索引: 索 引 中 文 原 文 1 [Magento2如何创建模块](https://forum.magentochina.org/t/Magento-2%E5%A6%82%E4%BD%95%E5%88%9B%E5%BB%BA%E6%A8%A1%E5%9D%97%E6%95%99%E7%A8%8B/38)[How to Create Module in Magento 2](https://www.mageplaza.com/kb/how-create-hello-world-module-magento-2.html) 2 [控制器详解](https://forum.magentochina.org/t/Magento-2%E6%8E%A7%E5%88%B6%E5%99%A8%E8%AF%A6%E8%A7%A3%E6%95%99%E7%A8%8B/39)[Create Controllers](https://www.mageplaza.com/magento-2-module-development/how-to-create-controllers-magento-2.html) 3 [CRUD 模型](https://forum.magentochina.org/t/Magento2-CRUD%E6%A8%A1%E5%9E%8B%E8%B5%84%E6%BA%90%E9%9B%86%E5%90%88%E5%B7%A5%E5%8E%82%E5%AF%B9%E8%B1%A1%E8%AF%A6%E8%A7%A3%E6%95%99%E7%A8%8B/43)[CRUD Models](https://www.mageplaza.com/magento-2-module-development/how-to-create-crud-model-magento-2.html) 4 [视图层:块,布局和模板](https://forum.magentochina.org/t/%E8%A7%86%E5%9B%BE%E5%B1%82%E5%9D%97%E5%B8%83%E5%B1%80%E5%92%8C%E6%A8%A1%E6%9D%BF%E6%A8%A1%E6%9D%BF%E6%95%99%E7%A8%8B/50/1)[View: Block, Layouts and templates](https://www.mageplaza.com/magento-2-module-development/view-block-layout-template-magento-2.html) 5 [配置system.xml](https://forum.magentochina.org/t/%E5%A6%82%E4%BD%95%E5%88%9B%E5%BB%BA%E7%B3%BB%E7%BB%9F%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6systemxml/55)[Configuration - System.xm…](https://www.mageplaza.com/magento-2-module-development/create-system-xml-configuration-magento-2.html)

## About Magento2 API

Magento 2创建API的意思是帮助在线零售商开发自己的应用程序接口。  
在Magento 2中创建API，您可以很容易地获得所有构建块来成功地启动一个程序。

为了更好地支持Magento 2模块的开发，Mageplaza小组尝试在你的[hello world模块](https://forum.magentochina.org/t/Magento2%E6%A8%A1%E5%9D%97%E5%BC%80%E5%8F%91%E4%B8%AD%E6%96%87%E6%95%99%E7%A8%8B%E7%B4%A2%E5%BC%95/36)中建立API测试程序.

> http://\<magento\_host\>/swagger

## What is API

API（Application Programming Interface,应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。  
因此，如果您从其他网站请求任何程序或服务，API是连接数据的必需元素.  
作为基于Magento 2平台的电子商务商店，您应该看看两种架构类型的web APIs: REST (Representational State Transfer)和SOAP(Simple Object Access Protocol)。但是，在正式的文档中，它们只使用原始的curl请求，没有任何示例。为了有效地连接和使用Magento 2 API，本主题将详细介绍PHP示例。

## 代码片段

File: **etc/webapi.xml**

```
<?xml version="1.0" ?>
<routes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Webapi:etc/webapi.xsd">
<route method="GET" url="/V1/mageplaza-helloworld/post">
	<service class="Mageplaza\HelloWorld\Api\PostManagementInterface" method="getPost"/>
	<resources>
		<resource ref="anonymous"/>
	</resources>
</route>

```

File: **etc/di.xml**

```
<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
<preference for="Mageplaza\HelloWorld\Api\PostManagementInterface" type="Mageplaza\HelloWorld\Model\PostManagement"/>
</config>

```

File: **Model/PostManagement.php**

```
 <?php 
namespace Mageplaza\HelloWorld\Model;

class PostManagement {

/**
 * {@inheritdoc}
 */
public function getPost($param)
{
	return 'api GET return the $param ' . $param;
}
}

```

File: **Api/PostManagementInterface.php**

```
<?php 
namespace Mageplaza\HelloWorld\Api;

interface PostManagementInterface {

/**
 * GET for Post api
 * @param string $param
 * @return string
 */

public function getPost($param);
}

```

原文来自于:

> **[How to Create Custom REST API in Magento 2 - Mageplaza](https://www.mageplaza.com/magento-2-create-api/)**
>
> Creating a custom REST API in Magento 2 helps generate an Application Programming Interface for your own use. Here is a detailed guide to creating a custom REST API.