JavaScript - 后端接口编写规范示例（API）

前言

当后端完成一个 API 接口时，通常需要 与前端人员沟通接口的细节，这时候，一个文档就能节省很多效率，大大减少沟通成本，如何撰写一份规范文档呢？

功能描述

用最简洁清晰的语言，让不懂后端的前端一看就懂。

主要说明该方法实现什么功能（很重要），涉及术语需要标注。

URL地址

例如：/admin/user/

请求方式

调用该接口前端需要使用什么方式来请求（GET / POST / PUT / DELETE …）

请求参数

此块最好使用表格来描述。

调用该接口时，前端需要传递哪些参数值，主要有以下几个方面：

• 【字段】：对应的字段名称，如 userName / pwd。
• 【说明】：对于该字段的说明，如 用户名 / 密码。
• 【类型】：对于该字段类型，如 Array / Object 。
• 【是否必填】：Y/N / True/False
• 【备注】：对于该接口有什么备注。