0

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

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

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

我是否必须像此网页http://coreymaynard.com/blog/creating-a-restful-api-with-php/那样为 API 提供代码

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

还是我只需要说明资源、它们的表示、对不同类型的 uri 的不同类型的操作以及相应的响应。

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

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

4

1 回答 1

3

在业务中,设计文档通常意味着您正在计划功能的技术流程/结构,并解释其好处和可能的缺陷等。很难判断您的老师是否真的在谈论 API 设计看待。大多数情况下,他可能希望您列出所有 API url 并解释每个方法适用于哪种方法,以及它们的功能是什么。

很有可能,如果他指的是后一种含义的 RESTful api 设计,那么它可能类似于 Rails 显示其路线的方式:

在此处输入图像描述

于 2013-10-11T21:16:06.433 回答