关于api:写一个新的接口之前我通常会思考这几个问题

我在开始一个新的接口之前，须要进行以下判断：

1. 申请协定是不是 HTTP、https?
2. 申请体和响应格局是什么（XML、JSON、FormData、Raw）?
3. API 是不是 RESTful 格调？

如果下面三个问题的答案都分明了，就能够开始新增一个 API 接口。

API 信息

在编辑 API 的顶部填写 API 的申请协定、形式、地址、名称；

协定反对

• HTTP/HTTPS

申请形式反对

• POST
• GET
• PUT
• DELETE
• HEAD
• OPTIONS
• PATCH

API 申请参数

设置申请头部

你能够输出或导入申请头部。

除了手动输出，你还能够批量导入申请头部，数据格式为 key:value，一行一条 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

设置申请体

申请体提供了五种类型：

1. Form-data（表单）
2. Json
3. XML

4. Raw(自定义文本类型数据)

   设置 Query 参数

   Query 参数指的是地址栏中跟在问号？前面的参数，如以下地址中的 user_name 参数：

   /user/login?user_name=jackliu

   批量导入的数据格式为？key=value…, 通过 & 分隔多个参数，如：

   api.eolinker.com/user/login?user_name=jackliu&user_password=hello

   设置 REST 参数

   REST 参数指的是地址栏被斜杠 / 分隔的参数，如以下地址中的应用大括号包裹起来的 user_name、user_password 参数：

/user/login/{user_name}/{user_password}

WARNING

留神，你只须要在 URL 中应用 {} 将 REST 参数括起来，表单的参数名不须要填写 {}。

API 响应内容

设置响应头部

你能够输出或导入响应头部。批量导入的数据格式为 key : value，一行一条 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

设置响应内容

响应内容的编写形式和申请参数的相似，响应内容提供了四种类型：

1. Json
2. XML
3. Raw(自定义文本类型数据)

有须要这个开源 API 工具的敌人，大家能够去间接去这里：

代码仓库：https://github.com/eolinker/e…

Eoapi 官网：https://www.eoapi.io/?utm_sou…

有残缺的开发文档，但如果你还是有任何对于 Eoapi 方面的技术问题，能够去 Github 征询交换，PM 会及时回复，帮你排除阻碍！