Warning: file_get_contents(/data/phpspider/zhask/data//catemap/8/api/5.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/0/assembly/6.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Restful API设计文档_Api_Rest_Document - Fatal编程技术网

Restful API设计文档

Restful API设计文档,api,rest,document,Api,Rest,Document,作为我家庭作业的一部分,我必须这样做: 您需要向我们发送一份关于如何为在线商店实现restfull API的设计文档。它应该支持添加、删除、编辑和搜索产品。你可以随意假设其他任何事情,但一定要把它们记录下来。确保您考虑过身份验证(只有经过身份验证的用户才能添加/查看/编辑/删除项目)。您正在为将使用该API创建移动应用程序的移动开发人员创建API。如果您还可以包括一些示例场景以及预期的请求/响应对象,那就太好了 我不熟悉RESTfulAPI,但现在已经阅读了它们,并且很好地理解了所有的基本原理。

作为我家庭作业的一部分,我必须这样做:

您需要向我们发送一份关于如何为在线商店实现restfull API的设计文档。它应该支持添加、删除、编辑和搜索产品。你可以随意假设其他任何事情,但一定要把它们记录下来。确保您考虑过身份验证(只有经过身份验证的用户才能添加/查看/编辑/删除项目)。您正在为将使用该API创建移动应用程序的移动开发人员创建API。如果您还可以包括一些示例场景以及预期的请求/响应对象,那就太好了

我不熟悉RESTfulAPI,但现在已经阅读了它们,并且很好地理解了所有的基本原理。我只是不确定在上述问题中我需要做什么

我是否必须像在这个网页上那样为API提供代码

或者我不必编写代码,但我必须用英语解释代码的实现

或者我只需要声明资源、它们的表示、不同类型uri上的不同类型的操作以及相应的响应

我理解REST,但我只是不确定这个问题要求我做什么


对于RESTFUL API来说,设计文档到底是什么。

在业务中,设计文档通常意味着您正在规划功能的技术流程/结构,并解释其优点和可能的缺陷等。很难判断您的老师是否真的在谈论这方面的API设计。大多数情况下,他可能希望您列出所有API URL,并解释每个URL的方法以及它们的函数

如果他指的是后一种意义上的RESTful api设计,那么很可能类似于Rails显示路由的方式:


在商业中,“设计文档”通常意味着您正在规划某个功能的技术流程/结构,并解释其优点和可能存在的缺陷等。很难判断您的老师是否真的在谈论这方面的API设计。大多数情况下,他可能希望您列出所有API URL,并解释每个URL的方法以及它们的函数

如果他指的是后一种意义上的RESTful api设计,那么很可能类似于Rails显示路由的方式:


在商业中,“设计文档”通常意味着您正在规划某个功能的技术流程/结构,并解释其优点和可能存在的缺陷等。很难判断您的老师是否真的在谈论这方面的API设计。大多数情况下,他可能希望您列出所有API URL,并解释每个URL的方法以及它们的函数

如果他指的是后一种意义上的RESTful api设计,那么很可能类似于Rails显示路由的方式:


在商业中,“设计文档”通常意味着您正在规划某个功能的技术流程/结构,并解释其优点和可能存在的缺陷等。很难判断您的老师是否真的在谈论这方面的API设计。大多数情况下,他可能希望您列出所有API URL,并解释每个URL的方法以及它们的函数

如果他指的是后一种意义上的RESTful api设计,那么很可能类似于Rails显示路由的方式: