请问一下api接口和api文档是什么，还有我们平时说的api，就是接口吗，本人小前端

Question

请问一下api接口和api文档是什么，还有我们平时说的api，就是接口吗，本人小前端

Answer 1

API的全称是Application Programming Interface 如果你做前端的话那么这个词你肯定会听到想吐， 这个定义一般是由后端来定义和写，当然应该说看情况而定 在初定项目时 你也可以和后端说接口文档你来负责。 当然这种情况比较少。 具体到接口文档的话 其实就是 一个URL 在node中 的话 就是 req.query() 或者 req.url拿到的一些东西 建议你下载个postman专门测接口 还可以转文档对于你处理接口数据 再好不过了。

Answer 2

太专业的术语理解起来头大，由简入深吧。

大多数应用从无到有，大致经历以下阶段：

产品 - 开发 - 测试 - 上线 - 运维

大多数应用是以数据为中心，所有的功能最终都归结为对数据的增加、删除、修改、查询

为何有前端、后端？

在当今的互联网环境下，尤其是互联网应用
生产必须做到：快而稳的响应产品需求、快而稳的迭代应用版本.....最终目的是快速抢占市场、完成战略布局从而达到商业目的
性能必须做到：快而稳的响应用户请求、快而稳的呈现用户期望.....最终目的是解决用户痛点、培养用户习惯从而持续留住用户

以上两句话的核心在于“快”和“稳”
快：开发写的快、上线速度快、程序跑的快
稳：上线迭代稳、程序运行稳、用户体验稳

基于以上的快和稳，对比传统的软件开发流程（一个人要同时完成逻辑编程、页面交互、数据库等工作，效率不高且专注度和专业度都不算太高）必须要调整各部门、各工种、各岗位的工作方式/方法/流程，也就有了敏捷开发，敏捷开发涉及的不光是这些，还有很多。

在开发方面，数据库专人负责、业务逻辑编程专人负责、页面效果交互专人负责......专业的人做专业的事。由此，前后端分离的开发模式也就逐渐明晰并且逐步形成规范，可以最大程度的提升技术上的、流程上的、管理上的效率和水平。

理解了前后端分离，再来说API。

正题：什么是API？什么是API文档？

前后端分离就是把业务逻辑和页面呈现分开了，后端就是业务逻辑，前端就是页面呈现，必须合在一块才是一个完整的应用。怎么合？

后端同学负责根据应用的功能点/业务逻辑编写API接口，API接口就是某个功能点/业务逻辑在后端的最终实现。

如果你调用过接口，就不再多说了，你肯定知道接口长啥样，没错，接口就长那样。

后端同学写了N多个接口提供给前端调用。那这些接口分别对应哪些功能点/业务逻辑？每个接口都需要什么参数？每个参数都是什么意思？哪些参数是必填的？哪些参数是可以不填的？每个接口能返回什么结果？返回结果的数据类型是什么？正确的情况下应该返回什么？错误的情况下应该返回什么？.............

这些问题在开发过程中，如果后端同学一字不说、一言不发，前端同学就崩溃了，我是谁？我在哪？鬼知道这些都是什么....

所以才会有API文档，API文档就是用来回答上面的问题的，是一个规范的、明确的接口说明书，详细的描述了每个接口的作用、入参、出参、返回值等等，此接口文档就作为前后端开发中衔接彼此工作的桥梁，即是对前后端同学开发工作的规范、约束，也是对应用的功能/业务逻辑的规范、约束，最大程度减少人的错误和代码的错误。

篇幅略大，字数略多，不知以上回答是否能让你解惑。

Answer 3

一般的 API 泛指 API 接口，但是文档应该是最基本的配套。

API

应用程序接口（英语：application programming interface，缩写作 API），又称为应用编程接口，就是软件系统不同组成部分衔接的约定。由于近年来软件的规模日益庞大，常常需要把复杂的系统划分成小的组成部分，编程接口的设计十分重要。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。

Answer 4

我理解api指的是某一功能的使用方法

比如后端返回的api的作用是获取用户列表，那么api文档中描述的就是如果使用这个接口才能正确返回用户列表
再比如nodejs的api文档的http模块，里面描述的就是如何使用这个http模块才能正确的进行请求操作。

Answer 5

Web 的接口通常是前端向接口发起请求，后端执行相应操作
通常是前端发起 get 请求，后端返回相应数据
前端发起 post 请求，后端对前端传过来的数据进行处理
而 API 文档说明了如何使用 API，向 API 发起请求应该用什么样的格式之类的
拿一言的 API 举个例子

https://v1.hitokoto.cn/

向这个 api 发送 get 请求时，一言的服务器会随机返回一句话，格式为 json

{
  "id": 657,
  "hitokoto": "假如我们相遇，肯定一眼就能认出彼此",
  "type": "a",
  "from": "你的名字",
  "creator": "酷儿",
  "created_at": "1475388232"
}

前端就可以使用这个返回的数据

Answer 6

前端范畴提到的API指后端提供的接口。
具体有以下要素：

1. 请求地址
2. 请求方式
3. 请求头
4. 是否需要鉴权
5. 请求数据
6. 响应数据（成功和失败都需要列出来）

满足以上要求的API文档才能使前后端工作标准化， 前端不用问后端问题，直接按照文档开发即可