Javascript 如何编写服务层规范?
我目前正在为web应用程序构建前端原型,很快后端程序员将开始构建服务层。他们让我写一个简单的数据格式规范,包括可能的参数等 是否有任何标准的方式来编写或组织此类规范?有人能举个例子吗 PS:所有服务请求都将在Javascript中异步完成。与后端团队一起编写一个 设计文档需要是一个稳定的参考,概述软件的所有部分以及它们将如何工作。要求文档提供相当完整的描述,同时保持软件的高级视图Javascript 如何编写服务层规范?,javascript,api,rest,specifications,web-frontend,Javascript,Api,Rest,Specifications,Web Frontend,我目前正在为web应用程序构建前端原型,很快后端程序员将开始构建服务层。他们让我写一个简单的数据格式规范,包括可能的参数等 是否有任何标准的方式来编写或组织此类规范?有人能举个例子吗 PS:所有服务请求都将在Javascript中异步完成。与后端团队一起编写一个 设计文档需要是一个稳定的参考,概述软件的所有部分以及它们将如何工作。要求文档提供相当完整的描述,同时保持软件的高级视图 定义数据。应用程序处理的任何数据(客户端和服务器) 定义架构。正如您所提到的,您正在使用异步Javascript从
- 定义数据。应用程序处理的任何数据(客户端和服务器)
- 定义架构。正如您所提到的,您正在使用异步Javascript从客户端到服务器进行HTTP调用
- 定义接口。一旦您对数据和体系结构有了共同的理解,接口就更容易组合起来。接口描述通常描述所有函数(带有简短的描述、参数和返回值)。如果您想要一个RESTful接口描述的示例,请查看文档