接⼝⽂档简介
What:
接⼝⽂档⼜称为API⽂档,⽤来描述系统所提供接⼝信息的⽂档。
接⼝⽂档类似于机器的使⽤说明书。
通俗的讲，接⼝⽂档能告诉开发者接⼝能返回的数据，以及为了获取这些数据，开发者需要输⼊什么样的数据，请求哪个接⼝。⾃⼰写了个抽象的公式：input? -> interface -> output?
Where:
互联⽹⾏业：前后端分离的web项⽬，对外的系统对接项⽬。
在下猜测，游戏⾏业，客户端与服务端也应该需要类似的⽂档。
Who:
⾏业现状⼀般是由开发⼈员所编写的, ⽽且⼀般是由后端开发编写与维护。⼼痛1秒。
How:
本⼈有幸，见过P7写的接⼝⽂档，可惜悟性不够，只参悟了三四分。具体如下：
1.项⽬环境
⽇常：
预发：
线上：
2.XX接⼝
请求url：
项⽬环境 + /api/info
请求类型：
POST
请求头：
接口文档怎么看
content-type: application/json
token: woej1foiq34iqj52pierg
请求参数：
body = {
"id":"9dac8d7d2d2111ce4201cb9d1e5c",  // id
"m":"2021-03",  // 年⽉
"m":"2021-03",  // 其它筛选条件
}
响应参数：
i.请求成功：
"content":{
"api":"http.datacenter.api",
"data":{...},  // 成功会返回数据
"version":"1.0",
"success":"true"
}
    ii.请求失败：
"content":{
"api":"http.datacenter.api",
"data":"FAILED: No Permission!",  // 失败返回原因 or 状态码
"version":"1.0",
"success":"false"
}

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。