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 創建指令、程序和示例。