如何编写服务层规范？

Question

我目前正在为Web应用程序构建一个前端原型，很快后端程序员就要开始构建服务层。他们要求我写下我想从各种服务中获得的数据格式的简单说明以及可能的参数等。

是否有任何标准的编写或构造此类规格的方法？任何人都可以举个例子吗？

PS：所有服务请求将以Javascript异步完成。

Answer 1

写一个SDD与后端船员。

设计文档需要是一个稳定的参考，概述软件的所有部分以及它们如何工作。命令文档给出相当完整的描述，同时保持软件的高级视图。

• 定义数据。无论您的应用程序处理什么数据（客户端和服务器）。

• 定义架构。正如您所提到的，您正在使用异步Javascript从客户端到服务器进行HTTP调用。

• 定义接口。一旦你对数据和体系结构有了共同的理解，接口就更容易组合起来。接口描述通常描述所有功能（具有简短描述，参数和返回值）。如果您想要RESTful接口描述的示例，请查看enStratus文档。

使用大量图片和实例，使可读文件。不要太长：K.I.S.S！