magento2使用api-设置自定义路由

2年 前
阅读本文预计花费：1 分钟
作者：晓风拂月
7天成为Magento系统架构师，现在开始学习Magento全栈开发！

《Magento2.X企业级开发实战》

设置自定义路由
您可以在模块中配置 REST 端点以使用 URL 的自定义路由（别名）而不是默认 URL。 例如，您可以定义别名 createWidget 来表示 POST V1/widgets。 但是，您不能为包含一个或多个变量的路由创建别名，例如 PUT V1/widgets/:widgetId。

要定义自定义路由，请在包含以下结构的模块中创建一个 etc/webapi_async.xml 文件：

<services xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_WebapiAsync:etc/webapi_async.xsd">
    <route url="V1/widgets" method="POST" alias="createWidget" />
    <route url="async/bulk/V1/widget" method="PUT" alias="asyncBulkUpdateWidgets"/>
    .........
</services>

这个例子重新定义了两条路由：
在端点 POST /createWidget 上发出的所有请求都将转发到 POST V1/widgets
在端点 PUT /asyncBulkUpdateWidgets 上发出的所有请求都将转发到 PUT async/bulk/V1/widget
下表定义了路由节点属性：

属性名称是否必须说明
urlYes现有的 REST 端点。 路由可以在模块的 webapi.xml 文件中定义，也可以派生，例如用于异步和批量端点的那些。
methodYesHTTP 请求方法。 GET、PUT、POST 或 DELETE。
aliasYes一个字符串，用于为 url 中定义的路由定义自定义路由。
如无特殊说明或标注，任何个人或组织，复制、转载、采集本站内容请注明：
本文来源于：【Magento中文网】，并添加本文地址链接。
如未按上述操作复制或转载，本站有权追究法律责任。
若本站内容侵犯了原著者的合法权益，可联系我们进行处理。
上一篇:
下一篇: