标签： javascript api rest specifications web-frontend
我目前正在构建一个Web应用程序的前端原型，很快后端程序员将开始构建服务层。他们让我从各种服务中写下我想要的数据格式的简单规范以及可能的参数等。
是否有任何标准的编写或构建此类规范的方法？谁能举个例子？
PS：所有服务请求都将以异步方式在Javascript中完成。
答案 0 :(得分：3)
与后端工作人员一起写SDD。
设计文档需要是一个稳定的参考，概述软件的所有部分以及它们的工作方式。该文件被命令提供相当完整的描述，同时保持软件的高级视图。
定义数据。无论您的应用程序处理什么数据（客户端和服务器）。
定义架构。正如您所提到的，您正在使用asynchronic Javascript从客户端到服务器进行HTTP调用。
定义接口。一旦您对数据和体系结构有了共同的理解，接口就更容易组合在一起。接口描述通常描述所有功能（带有简短描述，参数和返回值）。如果您想要RESTful接口描述的示例，请查看enStratus文档。
使用大量图片和示例使文档可读。不要太久：K.I.S.S！