Java或PHP中REST-API的样例请求


Sample Request for a REST-API in Java or PHP

我正在考虑使用他们的API从调查工具中提取数据。由于我对api相当陌生,我浏览了它们的文档和一些视频,弄清楚了其中发生的一些事情。

但是除了方法和属性之外,它们还有一个Java/PHP的示例请求和示例响应。样本响应是JSON文件格式但样本响应有什么用呢?

就像我在所有视频中看到的那样,使用特定的URL调用API。这个请求样本是用来做什么的?是为了在您自己的代码中使用它吗?

我知道这是一个相当愚蠢的问题,但任何输入都会非常感谢。

假设您有一个管理"虚拟机"的系统;它提供了如下API:

/system/create-new-virtual-machine
/system/{virtual-machine-id}/start

所以:你的客户端将首先调用第一个API方法以某种方式定义一个新的虚拟机(提供创建配置所需的所有数据)。

显然,当你创建一个新的东西,这应该导致一个新的URI;之后你会用它来打其他电话。在我们的示例中,create调用将返回200…并在结果体中提供新创建vm的URI。

长话短说:只要把你的REST api想象成你的代码正在处理的组件/模块的接口。一些API操作只是告诉你"很好,我通过了"……但是其他人会想要给你反馈信息。这就是你需要的响应体