宁静的API设计文档

Question

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

您需要向我们发送一份设计文档，说明如何为在线商店实现Restfull API。 它应该支持添加，删除，编辑和搜索产品。 您可以随意承担其他所有事项，但请确保将它们记录下来。 确保您已考虑过身份验证之类的事情（只有经过身份验证的用户才能添加/查看/编辑/删除项目）。 您正在为将要使用它来创建移动应用程序的移动开发人员创建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显示其路线的方式：