乐趣区

关于接口:什么是接口定义-接口定义的概念和用途详解

很多人会议论接口或者 API 的定义。到底什么是接口定义?如何浏览接口定义?

一、前端和后端

在议论接口之前,让咱们先明确前端和后端这两个概念。

前端是咱们在网页或挪动应用程序中看到的页面,它由 HTML 和 CSS 编写而成,让咱们看到丑陋的页面,并进行一些简略的校验,例如确保必填字段不为空。后端则实现了页面上的业务逻辑和性能,例如购物和公布微博等性能。当你在页面上进行这些操作时,后端会负责扣除余额或将微博公布到指定的账户。那么前端和后端如何交互呢?这就是通过接口实现的。

尽管这些概念可能有点形象,但你只须要记住:前端负责让页面看起来丑陋,后端负责实现网页的性能。

无论是网页还是安卓 /iOS 客户端,或者是微信小程序,或者是 Windows/Mac 上的软件,都是同一个情理,都会辨别前端和后端。前端就是在你的手机或者电脑上运行的那个软件,后端则是在服务器上运行的那个软件。

在公司里,前端和后端往往会分成不同的职位,他们开发和实现的货色也截然不同。

二、接口

理解了前端和后端的概念,接下来就到接口了。

接口是一种通信机制,用于在前端和后端之间替换信息。能够将其设想为两个人之间在对话。

前端就像提问者,而后端则像回答者。以后端须要某些信息或执行某些工作时,它会通过一个接口向后端发送申请。这个申请就像是一个问题,通知后端须要做什么。后端则会依据申请执行相应的操作,并将后果返回给前端。这个后果就像是答案,通知前端实现了什么工作或提供了哪些信息。

这种交互就像一个问答游戏,前端和后端通过接口一直地问答,从而实现应用程序的性能和数据交换。例如,当你在购物网站上点击“退出购物车”按钮时,前端会向后端发送一个申请,通知它要将该商品增加到购物车中。后端将执行相应的操作,并将后果返回给前端,通知它是否胜利增加了商品。

总之,接口就像是前端和后端之间的“对话”,用于替换信息和执行工作。

接口又叫 API(Application Programming Interface)。咱们个别讲到接口或者 API,指的都是同一个货色。

三、接口定义

每个服务器都会提供不同的接口。比方,麦当劳的点餐服务肯定会提供以下几个接口:

  1. 查看菜单
  2. 下单
  3. 查问我的订单

你关上麦当劳的小程序时,小程序就会发动一个申请“查看菜单”,服务器会返回一个菜单数据,显示在你的手机上。你选好餐,点击“下单”的时候,就会发动一个下单申请,服务器就会返回“下单胜利”。你在小程序点击“我的订单”的时候,也会发动一个查问订单的申请,服务器就会返回你的订单列表。

以“下单”为例,下单必定要蕴含消费者的信息,以及消费者点了什么餐。所以,小程序发动的下单申请就必须蕴含这些信息,否则就会下单不胜利。同样的情理,服务器返回的胜利下单的详情也必须蕴含这些信息,否则在小程序里就会显示不残缺。

也就是说,开发工程师在写小程序和服务端的代码的时候,就曾经规定好了信息替换的格局。客户端申请必须蕴含什么信息,服务端返回必须蕴含什么信息。这个规定就是接口定义。

而每个服务都会蕴含很多种不同的接口,比方下面提到的三种接口,它们都会各自有一套申请信息和返回信息的规定。

所以,接口定义就是软件开发时,对于前端如何申请信息,后端如何返回信息的构造的规定。前后端都遵循雷同的接口定义,使得不同的模块之间能够相互合作,实现简单的性能,同时保证系统的稳固和可靠性。

四、接口定义的组成

一个接口的定义次要蕴含以下几个局部:

  1. 接口名称:即接口的名称或标识符,用于辨别不同的接口。
  2. 接口办法:即接口所提供的办法,包含 GET、POST、PUT、DELETE 等。
  3. 接口地址:即接口的拜访地址。
  4. 申请参数:即接口所须要的输出参数,包含参数名称、参数类型、参数阐明等。
  5. 响应参数:即接口所返回的输入后果,包含返回值的类型、名称、阐明等。

一个典型的接口定义是这样的:

这个接口是在 Apifox 里定义的。应用 Apifox 能够不便地进行可视化的 API 定义、开发、调试、测试。

五、浏览支流厂商的 API 定义

对 API 定义有了根本的理解之后,你能够浏览支流大厂的 API 定义来加深对于 API 定义的了解。

在 Apifox 的 API Hub 提供了各家公司的开发 API,点击拜访:https://apifox.com/apihub/

例如,以下这个就是企业微信的 API 定义。

常识扩大:

如果你想理解更多接口相干的应用技巧,能够查看以下文章:

  • 如何读懂常见的接口文档?
  • OpenAPI 接口标准详解,让 API 开发更加标准化
退出移动版