API简介

1、定义

API（application programming interface，应用程序编程接口）是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。

2、组成

一个完整的接口一般包含以下内容：
（1）接口说明
（2）请求链接（url）
（3）请求方法（get、post、put、delete，对应见、生、变、灭）
（4）请求参数、参数类型、请求参数说明
（5）请求头（非必要）
（6）返回参数说明

2.1、请求方法

2.1.1、get

get请求使用query string parameters，在Params处填写必要的参数，然后将参数传递给服务器。

2.1.2、post

POST请求方法旨在将数据传输到服务器，返回的数据取决于服务器的实现。
POST请求可以使用query string parameters以及body将参数传递给服务器。（一般用的是body，query string parameters会在URL暴露参数信息）
|body数据类型说明:|

类型	说明
form-data	form-data 是web表单用于传输数据的默认编码。既可以上传键值对，也可以上传文件。当上传的字段是File时，会有Content-Type来说明文件类型；content-disposition，用来说明字段的一些信息；由于有boundary隔离，所以multipart/form-data既可以上传文件，也可以上传键值对，它采用了键值对的方式，所以可以上传多个文件，适合传输长字节。form-data的数据类型，可以选择Text或者File。Text是默认的。
x-www-form-urlencoded	它是post的默认格式，使用js中URLencode转码方法。相当于application/x-www-from-urlencoded，会将表单内的数据转换为键值对。只能上传键值对，无法通过此编码模式上传文件，并且键值对都是间隔分开的。urlencoded中的key-value会写入URL，form-data模式的key-value不明显写入URL，而是直接提交。
raw	可以上传任意格式的文本，可以上传text、json、xml、html等
binary	相当于Content-Type:application/octet-stream,从字面意思得知，只可以上传二进制数据，通常用来上传文件（图像、音频、视频文件），由于没有键值，所以，一次只能上传一个文件。

2.1.3、put

put请求主要是从客户端向服务器传送的数据取代指定文档的内容。
put请求可以使用query string parameters以及body请求体将参数传递给服务器。

2.1.4、delete

delete方法用于删除服务器上的资源，delete请求可以使用query string parameters以及body请求体将参数传递给服务器。

2.2、请求头

request header用来说明服务器要使用的附加信息，包括Accept、Cookie、User-Agent、Accept-Encoding等等。

2.3、响应体

基于restful风格的API，一般返回的是json类型的数据。里面会包含响应状态码和其他一些有用的信息。

3、类型

3.1、webService接口（xml报文数据返回）

它使用soap协议并通过http传输，请求报文和返回报文都是xml格式的，我们在测试的时候通过工具才能进行调用。可以使用的工具有SoapUI、jmeter。

3.2、http-api接口（json数据返回）

它使用http协议，通过路径来区分调用的方法，请求报文都是key-value形式的，返回报文一般都是json串，有get和post等方法，这也是最常用的两种请求方式。可以使用的工具有postman、jmeter等。

3.3、Dubbo类型接口

Dubbo(读音[ˈdʌbəʊ])是阿里巴巴公司开源的一个高性能优秀的服务框架，使得应用可通过高性能的 RPC 实现服务的输出和输入功能，可以和Spring框架无缝集成。