如何理解接口？我们说到接口，首先要分为前端和后端。 前端有Android、IOS和Js，后端定义返回值、参数、请求方式、协议等。 系统a调用系统b，系统b调用系统c。 它就像连接多个系统的桥梁，每个都遵守同样的约定，但他自己是协议。 由于对传递的对象所需的特定特性进行了规范，因此调用时不会出现错误，也不需要预先检查。
在现实生活中，例如板上有三个头的两头，手机充电器上有usb，typec。 在现实生活中，这些接口实际上是合同，可以连接两个对象，只要你按照接口的要求，就可以与另一个对象相互连接。 例如，所有三个插头都可以插入三只眼睛的插头板上。 充电器也一样。
接口规范是什么？接口五要素
1、接口数据格式(返回值)返回值一般包含代码状态代码，message返回消息，data返回数据为什么是返回这三个字段？
1、层次化更加清晰
2、前端处理方便
除了这个方法以外，还有什么方法实现返回值信息？
使用http状态进行识别
这样可以降低代码的复杂性
2、接口参数接口参数一般包括字段名称、字段类型、是否必填、注释说明等字段1、字段命名有什么要求？
首先推荐含义明确的单词
驼峰式
用小写字母划线
后续接口将被改版，以确保字段的含义不会丢失
2、为什么大部分类型定义都是string和int呢？
这其实和后端语言有关。 有些人在使用java。 如果不注明我是什么类型的话，在后端受到强转换可能会出错。 这是代码中与业务逻辑无关的检查逻辑。 这些事情其实是框架做的。
请想想为什么我们在接口文档中写string。 后端java接收的是字符串。 前端属于这种类型吗？ 看看url参数中这样的是字符串还是数字有区别吗？ 没有，但是我们做了这个约定之后，在写java代码的时候，约定的意思是这是整数，我采取整数型的parseInt这种方式，去接收这个参数，几乎不报告错误。 如果报告了错误，前端会告诉你错误。
这种方式被称为“承诺大于配置”，是Maven中非常重要的理念。 如果我想减少这个错误，我的任务是双方都必须遵守这个约定。 你传达数字，一定是12345678910这个数字。 不是张三李四这个字符串。 这是约定。 应该传达数字的时候，必须传达字符串。 那个程序报告错误。 这是双方没有遵守这个承诺。
什么是部署？ 在name中，中学编号XX_XXX的自我分析可以理解为在配置中添加type以区分什么类型。 我写代码的时候，大家都遵守这个约定，只有一个接口文档。 实际上，在开发中，多个平台的Android、IOS和前端可能遵循同一接口文档。
3、为什么要有必须项？
后端接口是为数据库字段设计的，有些字段如果不传递程序就会出现错误，则不能为空。4、备注和说明应该怎么写？
1、给别人看2，比如字段写清楚列举类型a表示什么，b表示什么就可以了。5、参数到底放url在后，还是放一个body里面
1、按ID或其他单个字段进行咨询时，建议放在url后面2、按表格提交咨询，轻松在body中找到6、为什么使用JSON作为返回值
XML和JSON两种方式很常用，有比JSON更简洁的格式吗？ 我们常用的Spring配置YML是比JSON更简单的文件。 选择JSON后，设计比XML更简单、更平衡。 而且，我们暂时不需要更简洁。
3、需要什么样的数据(具体要求的URL )？ 例如，GET https//baidu.com/api/{模块名称}/{？ 菜单名称(/)接口名称) }/:param的具体数据从域名后面开始，明确要提取哪个数据。
典型协议地址的端口号不必死在文档中。 它可能位于多个域名下。 地址会发生变化。 一般来说，提供以下方法即可。 4、HTTP方法： GET、POST、PUT、DELETE定义了接口请求方式，常用有以下四种
5、协议(http、https )大致可分为http接口、api接口、RPC接口、RMI、web服务、rest风格等
什么时候写接口文档？
1、方案审查前？ 方案审查之后？
这里有两个方面： 1、熟悉业务和系统，如果有需求的话，不用考虑计划，也能知道界面是怎么写的2、没有经验。 在计划审查之前，确认需要一次前端和后端，然后确认界面信息(发起人，可能是前端)。 3、方案评审后，有小调整可以直接修改。 2、界面到底怎么决定，前后端一起定义吗？
1、客户端提出接口要求(包括样式建议) 2、服务端给出接口细节