API接口是什么？怎么去看懂API接口文档？

目前是前后端分离api后端做前端用，对于新手小白如何看懂api接口 api是什么所今天我带大家来了解一下API

什么是API接口

从一个比喻来讲，想要将手机上的内容传到电脑上去，可以用一根数据线将二者相连，就可以实现将手机中的内容传到电脑里面去了。其中数据线两端的接口就是API接口。

API，英文全称Application Programming Interface，翻译为“应用程序编程接口”。是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。只需要了解这个函数怎么用就可以了。

在项目开发汇总，web项目的前后端是分离开发的。应用程序的开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

为什么有API接口文档

1）项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发

2）项目维护中或者项目人员更迭的时候，方便后期人员查看、维护

怎么看懂API文档

API 接口文档一般分为接口描述、接口地址、请求方法、请求参数、相应内容、错误代码、实例几个部分。

1、接口描述：简单描述接口的逻辑和作用

2、接口地址：接口的正式 url 和接口测试的 url，需求方通过调用接口 url，获取响应内容

3、请求方法：一般来说，接口最常见的请求方法为 GET 和 POST 两种方式，即读接口和写接口。通过这两种方式，实现对数据的增删查改。增删改本质都是写的动作。

4、请求参数：即需要请求的字段名的名称和规则：都是哪些字段，字段的类型是什么，是否必填字段等等

5、响应内容：接口返回的字段名称和规则。注意：大部分开发往往不会把所有的字段罗列，只会列出比较重要的字段。当你发现，接口文档中没有你需求的字段，别着急找开发，可以看下实例中，有没有需求的字段。

6、错误代码：对接口的错误用代码进行归类，以便能快速找到错误原因，解决问题。

7、实例实际：调用时的响应的内容。

接口分为四部分组成

1）、方法:
新增(post) 修改(put) 删除(delete) 获取(get)
2）、格式：
以/a开头，如果需要登录才能调用的接口后面需要加/u(如新增、修改；前台的用户个人信息，资金信息等)，即：/a/u；中间一般放表名或者能表达这个接口的单词；
get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾。

3）、请求参数和返回参数，
都分为5列：字段、说明、类型、备注、是否必填
    字段：类的属性

    说明：中文释义；

    类型：属性类型；

    备注：一些解释，或者可以写一下例子，比如负责json结构的情况，最好写上例子（这里不是产品写），好让前端能更好理解；

    是否必填：字段的是否必填。

4）、返回参数结构的几种情况

    如果只返回接口调用成功还是失败（如新增、删除、修改等），则只有一个结构体：code和message两个参数；

    如果要返回某些参数，则有两个结构体：1是code/mesage/data，2是data里写返回的参数,data是object类型；

    如果要返回列表，那么有三个结构体，1是code/mesage/data,data是object，里面放置page/size/total/totalPage/list 5个参数，其中list是Arrary类型，list里放object，object里是具体的参数。
接口请求方式
基于http协议的常用请求方式是post和get；两者的主要区别如下：
（1）get请求方式是将请求参数放到url中，post是将参数放到requstbody中，
直接影响是get的请求参数存在长度限制，post无限制；其次是get将参数放到url中安全性弱于post；
（2）get请求方式用户端和服务端只产生一次交互，post请求方式用户端会和服务端产生两次交互，