目录:
1. 概述编辑
FDL支持通过 GET 和 POST 两种方式通过使用数据同步-RestAPI调用接口数据,进行数据开发。
本文为你介绍API 接口相关入门知识,便于您后续使用 FDL 进行数据开发。
2. 如何看接口文档?编辑
API接口文档一般分为接口描述、接口地址、请求方法、请求参数、响应内容、错误代码、实例几个部分:
内容 | 说明 |
---|---|
接口描述 | 简单描述接口的逻辑和作用。例如说明这是一个发送消息的接口、查询天气的接口 |
接口地址 | 这个地址表示的是网络地址,即url,我们需要调用接口url,获取响应内容 |
请求方法 | 常见的请求方法为 GET 和 POST,其他的方式见下图;注:FDL 支持GET和POST两种请求方式。 |
请求参数 | 用来传递信息的变量。即需要请求的字段名的名称和规则:都是哪些字段,字段的类型是什么,是否必填字段等等 详情参见本文第二节。
|
响应内容 | 接口返回的字段名称和规则 |
错误代码 | 对接口的错误用代码进行归类,以便能快速找到错误原因,解决问题 |
实例 | 实际调用时的响应的内容 |
2.1 GET请求
GET通常用于获取服务端数据:
GET方式在url后面拼接参数,只能以文本的形式传递参数;
传递的数据量小,4kb左右(不同浏览器会有差异);
安全性低,会将信息显示在地址栏;
速度快,通常用于对安全性要求不高的请求;
GET请求也可以有Headers参数
GET请求可以传递参数,一般的传递方式为 URL传参,例如:
在GET请求中,遇到参数 / Params / Querys 均是以 URL传参的形式进行传递。
在POSTMAN中,可以直接用 URL传参形式,也可以在Params处填写KEY和VALUE,会自动进行拼接(演示)。
在 FDL 中也可以通过直接URL传参或者请求参数写值自动拼接使用接口,如下图所示:
2.2 POST请求
post提交数据相对于get的安全性高一些。
传递数据量大,请求对数据长度没有要求;
用于密码等安全性要求高的场合,提交数据量较大的场合,如上传文件,发布文章等。
POST请求一般由Url 、 Headers 、 Body组成,如果在POST请求的接口文档里遇到 Params / Querys 则需以像GET请求一样使用URL参数传递参数,而POST请求的接口文档里面的参数一般指Body。
2.2.1 使用URL传参的接口
2.2.2 使用Body传参的接口
POST请求不同的请求格式:
类型 | 说明 |
---|---|
application/json,JSON数据格式,一般使用raw-JSON | 最常见的格式,例如 {"name":"Roxy","password":"123"} 注:FDL 目前支持该种类型。 此时的请求头为: |
text/plain,纯文本格式,一般使用raw-Text | 例如:name:ziv,password:123 |
text/xml(了解),XML数据格式,一般使用raw-XML | 例如: <?xml version="1.0" encoding="UTF-8" ?> <name>ziv</name><password>123</password> |
multipart/form-data | 它会将表单的数据处理为一条消息,以标签为单元,用分隔符分开。由于有boundary隔离,所以multipart/form-data既可以上传文件,也可以上传键值对,它采用了键值对的方式,所以可以上传多个文件 |
application/x-www-from-urlencoded | 会将表单内的数据转换为键值对,&分隔。 |
在 FDL 中输入请求头和请求参数使用接口,如下图所示: