我目前正在为 Web 应用程序构建前端原型，很快后端程序员将开始构建服务层。他们要求我编写一个简单的规范，说明我想要从各种服务中获得的数据格式以及可能的参数等。
是否有任何标准的方式来编写或构建此类规范？谁能举个例子？
PS：所有服务请求都将在 Javascript 中异步完成。
问问题
956 次
1 回答
3
与后端人员一起编写SDD 。
设计文档需要是一个稳定的参考，概述软件的所有部分以及它们将如何工作。该文档被要求提供相当完整的描述，同时保持软件的高级视图。
定义数据。无论您的应用程序处理什么数据（客户端和服务器）。
定义架构。正如您所提到的，您正在使用异步 Javascript 从客户端到服务器进行 HTTP 调用。
定义接口。一旦你对数据和架构有了共同的理解，这些接口就更容易组合在一起了。接口描述通常描述所有功能（带有简短描述、参数和返回值）。如果您想要一个 RESTful 接口描述的示例，请查看enStratus文档。
使用大量的图片和示例使文档具有可读性。不要让它太久：亲！
于 2013-09-25T11:13:11.067 回答