什么是REST API的组件?

时间:2017-08-31 16:47:10

标签: rest api terminology

是否有一个API的名称?

例如,假设我有一个API提供四种服务:

getCustomerInfo
setCustomerInfo
getProductInfo
setProductInfo

然后说,我想告诉同事:

  

API需要第五个webhook?

我知道这是对webhook这个词的错误使用。

正确的术语是什么? 谢谢!

更新:这可能是重复的。 krishna kanth在这里回答:What is an Endpoint?是:

  

术语Endpoint最初用于WCF服务。后来甚至   虽然这个词被用作API资源的同义词,REST   建议调用这些URI(URI [s],它们理解HTTP动词和   遵循REST架构)"资源"。

     

简而言之,资源或端点是一种入口点   远程托管的应用程序,允许用户与之通信   通过HTTP协议。

3 个答案:

答案 0 :(得分:4)

我认为你要找的是资源。我还认为获取和设置将合并在一个资源下,并且对该资源的HTTP调用将定义您是GETing还是PUTing(使用HTTP在REST中设置)。

答案 1 :(得分:2)

我认为通常API是各种软件组件之间的一组通信方法。

所以,我会说: API需要第五种方法吗?

Wikipedia还定义了API和方法: https://en.wikipedia.org/wiki/Application_programming_interface

答案 2 :(得分:1)

Roy Thomas Fielding在论文中将其定义为哲学博士学位的资源标识符(见Architectural Styles and the Design of Network-based Software Architectures)。

Roy Fielding说:

  

REST使用资源标识符来标识特定资源   参与组件之间的互动。

我相信您可以使用资源标识/product来处理product资源和资源标识/customer来处理customer资源。此外,使用适当的HTTP方法执行所需的操作。例如:

  • PUT转为/product/{id}以修改由product标识的{id}资源(而不是setProductInfo
  • 获取/product/{id}以返回由product标识的{id}资源的代表(而不是getProductInfo