乐趣区

关于api:写接口文档之前我会问自己-3-个问题

jiezi

为了让本人写的接口文档更加简洁明了，看起来不像个菜鸟写的，我 通常会在写接口之前问本人 3 个问题。

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

  • 申请协定是不是 HTTP/HTTPS？
  • 申请体和响应体格式是什么(XML、JSON、FormData、Raw)？
  • 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

设置申请体

申请体提供了五种类型：

  • Form-data（表单）
  • Json
  • XML
  • 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

设置响应内容

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

  • Json
  • XML
  • Raw（自定义文本类型数据）

本文中应用的写接口的工具就是 Eoapi, 它是 开源的 api 管理工具，它轻便且可拓展。

当然，如果你感觉它还不够满足你的需要，你有什么好的想法，无妨去 Github 上提个 issue，我的项目开发人员都会及时回复的。

该我的项目也有残缺的开发文档，如果你有什么技术问题，也能够去交换，PM 也会及时回复。

Github 地址：https://github.com/eolinker/e…
文档地址：https://docs.eoapi.io/?utm_so…

退出移动版