使用Swagger 和 Postman 来熟悉Magento2 REST APIs

使用Swagger 和Postman 来学习Magento2 的REST APIs是相当方便的,我们分别来看这两种方法。

1. Swagger

我们只需要在浏览器输入下面url就可以看到有限的游客可以使用的APIs,

Your_Magento换成你的Magento网站url

要看到全部的APIs,需要先在登录Magento后台,然后选 System-> Ingegrations 添加一个Integration。注意API选择ALL,这样我们可以看到完整的API

 

然后拷贝 Access Token:

把拷贝来的Access Token 填入到Swagger,并点击apply 按钮,然后刷新页面。

好了,现在我们就可以研究完整的Magneto2 的REST API 了,Swagger 可以测试API的完整参数,执行并返回执行结构。我们现在试试用Swagger通过 API 来获取一下产品的信息,我们找到 catalgoProductRepositoryV1 的get 方法,然后点击 Try it out 按钮

我们看到该API的所有参数都列了出来,我们来设置page size 为5,然后点击Execute 按钮:

执行的结果包括了所有的信息,请求url,完整的指令,以及返回的结果:

 

2. Postman

我们可以把Magento2 APIs 的完整规划导入到Postman,方便我们随时调用,要获得完整的APIs 规划,还是需要前面拷贝的 Access Token,我们也可以用命令行的方式来获取Access Token:

该命令会返回Access Token,然后把返回的Access Token 拷贝到下面命令并执行:

然后打开Postman,点击Postman 左上角的 Import 按钮,并选择我们刚刚生成的文件 magento2.api.schema.json, 这样我们在Postman中就导入了完整的 Magento2 APIs 规划:

从上图中我们可以看到,在执行APIs 时,Authorization 处要选择 Bearer Token, 并在右边填入我们的 Token,当然我们也可以把Token 保存为 预设,这样就不用每次都输入token了。

 

发表评论

电子邮件地址不会被公开。 必填项已用*标注

61 + = 66