Restful API设计文档

Question

作为我作业的一部分，我必须这样做：

  

您需要向我们发送一份设计文档，说明如何为在线商店实施restfull API。它应该支持添加，删除，编辑和搜索产品。您可以自由地假设其他所有内容，但请确保记录它们。确保您已考虑过身份验证（仅经过身份验证的用户可以添加/查看/编辑/删除项目）。您正在为将使用它创建移动应用的移动开发人员创建API。如果您还可以包含一些示例场景以及预期的请求/响应对象，那将会很棒。

我对宁静的api不熟悉，但现在已经了解了它们并且很好地理解了所有基本的基础知识。我只是不确定在上述问题中我需要做什么？

我是否必须在此网页http://coreymaynard.com/blog/creating-a-restful-api-with-php/

上提供API代码

或者我没有代码，但我必须用英语解释代码的实现？

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

我理解REST，但我不确定这个问题要求我做什么？

RESTFUL API的设计文档究竟是什么。

Answer 1

在开展业务时，设计文档通常意味着您正在规划功能的技术过程/结构，并解释其中的好处和可能的陷阱等，而且很难判断您的老师是否真的在谈论API在这方面的设计。大多数情况下，他可能希望您列出所有API网址并解释每个网址的方法，以及它们的功能。

如果他的意思是后者意味着RESTful api设计，那么它可能类似于Rails显示其路线的方式：