标签：datacenter www 请求 简介 接口 api 文档
What:
接口文档又称为API文档,用来描述系统所提供接口信息的文档。
接口文档类似于机器的使用说明书。
通俗的讲，接口文档能告诉开发者接口能返回的数据，以及为了获取这些数据，开发者需要输入什么样的数据，请求哪个接口。
自己写了个抽象的公式：input? -> interface -> output?
Where:
互联网行业：前后端分离的web项目，对外的系统对接项目。
在下猜测，游戏行业，客户端与服务端也应该需要类似的文档。
Who:
行业现状一般是由开发人员所编写的, 而且一般是由后端开发编写与维护。心痛1秒。
How:
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"
}
标签：datacenter,www,请求,简介,接口,api,文档 来源： https://www.cnblogs.com/asdsty/p/14513885.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。