如何写后端开发之接口设计文档

一、接口的理解

      当我们说到接口时，首先要分前端和后端，前端有Android、IOS、Js，后端定义返回值、参数、请求方式、协议等。

   统A调用系统B，系统B调用系统C，像是把多个系统连接起来的一座桥梁，各自遵守相同的约定，但他本身是一种协议。

它规范了传入的对象所必须具备的某些特征，从而保证在调用时既不会发生错误又不需要提前检查。

现实生活中的案例比如：

插板上面有三个头的、两个头的；手机充电器有usb的、typec的、有苹果接口的。

那么在现实生活中的这些接口其实就是一种契约，连接两个物件，只要你按照接口的要求来做，就能和另外一个按照这个接口对应的物件相互连接。比如所有三头的插头都可以插入三个眼的插板，充电器也一样。

接口规范是什么？

接口五要素

1、接口数据格式（返回值）

返回值一般包括code状态码，message返回消息，data承载数据

为什么是返回这三个字段？

1、分层更