API文档是什么意思

API 文档，也称为程序员文档，是技术写作的可交付成果，其中技术作家制定有关如何有效使用软件 API、硬件 (SCPI) 或 Web-API 的说明。

什么是 API?

API 是首字母缩写词，代表 应用程序编程接口。API 是一组预定义的规则和规范，软件程序可以遵循这些规则和规范来使用另一个软件程序提供的服务和资源。换句话说，API 是一种通信通道，通过它，两个独立的程序可以相互通信并共享彼此的服务和资源。

例如，以电视为例。您的电视上有一个硬件按钮，可以打开/关闭它。现在假设您想从远处打开电视。您只需按下遥控器上的开/关按钮，电视机就会模仿遥控器给出的命令。这就是 API 的工作原理!将电视视为具有服务和资源的软件程序，将电视遥控器视为使用这些资源的另一个软件程序。遥控器与电视机通信的方法(或无线电/红外线)是 API。

API的类型?

可以为大量软件程序创建 API，例如操作系统(OS 是一个大程序，对吗?)、软件应用程序、可编程硬件和软件库，以便其他软件程序可以使用这些软件程序提供的服务(如果有的话)程式。

根据它提供的媒体和服务，API 可以分为三个不同的组：

软件API

SCPI(硬件 API)

网络API

软件 API 是提供对其他软件提供的功能或服务的访问的 API。

例如，Microsoft Windows 在其 Shell32 库中有许多可用的 API。常用的 API 之一是 SHExitWindowsEx ，软件程序可以使用它来注销、关闭、重新启动、强制关闭或关闭Windows 操作系统。

语法调用是：

SHExitWindowsEx n (其中 n 可以取值为 0、1、2、4 和 8)

0 = 注销

1 = ShutDOwn

2 = 重新启动

4 = 强制

8 = 关机

SCPI 是一个首字母缩写词，代表 可编程仪器的标准命令。SCPI(通常发音为“skippy”)是一组预定义的规则和规范，用于控制可编程测试和测量设备。API 用于软件程序，SCPI 用于可编程测试和测量设备。

例如，“*IDN?” 是许多接口 (GPIB) 和可编程仪器中使用的标准 SCPI 命令，用于从设备获取基本识别数据。

WebAPI 是提供对 Web 服务(或网站)提供的功能或服务的访问的 API。在最简单的形式中，WebApi 通常是一组已定义的超文本传输​​协议( HTTP ) 请求消息，其中可能还包含响应消息结构的定义。WebAPI 的响应通常以标记语言编写，例如可扩展标记语言 ( XML ) 或JavaScript 对象表示法( JSON ) 格式。

什么是 API 文档?

API 文档是技术作者的可交付成果，它通过示例描述了如何有效地使用软件、硬件或 Web API。它需要对 API、它的参数、它的返回类型以及它支持的语言和接口有透彻的了解。具有编程知识的技术作家经常为随软件产品提供的 API 创建指令、程序和示例。