程序員如何寫介面文檔

1. 編程所寫的文檔指的是什麼

程序員寫文檔，主要解釋所寫的代碼有什麼用，用在哪裡，輸入，輸出，就是流程~~
~~~，文檔內容包括 流程，輸入，輸出，建立時間，建立人~~~

一旦出現問題，可以直接找到當事人，主要是讓代碼一目瞭然~~~，函數的使用方法，調用方式，函數的使用說明等~·

2. 軟體開發文檔的分類

1. 《功能要求》 -- 來源於客戶要求和市場調查，是軟體開發中最早期的一個環節。客戶提出一個模糊的功能概念，或者要求解決一個實際問題，或者參照同類軟體的一個功能。有軟體經驗的客戶還會提供比較詳細的技術規范書，把他們的要求全部列表書寫在文檔中，必要時加以圖表解說。這份文檔是需求分析的基礎。
2. 《投標方案》 -- 根據用戶的功能要求，經過與招標方溝通和確認，技術人員開始書寫《投標方案》，方案書一般包括以下幾個重要的章節： 前言 -- 項目背景、公司背景和業務、技術人員結構、公司的成功案例介紹等。 需求分析 -- 項目要求、軟體結構、功能列表、功能描述、注意事項等。 技術方案 -- 總體要求和指導思想、技術解決方案、軟體開發平台、網路結構體系等。 項目管理 -- 描述公司的軟體開發流程、工程實施服務、組織和人員分工、開發進度控制、軟體質量保證、項目驗收和人員培訓、軟體資料文檔等。 技術支持 -- 公司的技術支持和服務介紹、服務宗旨和目標、服務級別和響應時間、技術服務區域、技術服務期限、授權用戶聯系人等。 系統報價 -- 軟、硬體平台報價列表、軟體開發費用、系統維護費用等。 項目進度 -- 整個項目的進度計劃，包括簽署合同、項目啟動、需求分析、系統分析、程序開發、測試維護、系統集成、用戶驗收、用戶培訓等步驟的時間規劃。
3. 《需求分析》 -- 包括產品概述、主要概念、操作流程、功能列表和解說、注意事項、系統環境等。以《功能要求》為基礎，進行詳細的功能分析 ( 包括客戶提出的要求和根據開發經驗建議的功能 ) ，列出本產品是什麼，有什麼特殊的概念，包括哪些功能分類，需要具備什麼功能，該功能的操作如何，實現的時候該注意什麼細節，客戶有什麼要求，系統運行環境的要求等。這里的功能描述跟以後的使用手冊是一致的。
4. 《技術分析》 -- 包括技術選型、技術比較、開發人員、關鍵技術問題的解決、技術風險、技術升級方向、技術方案評價，競爭對手技術分析等。以《需求分析》為基礎，進行詳細的技術分析 ( 產品的性能和實現方法 ) ，列出本項目需要使用什麼技術方案，為什麼，有哪些技術問題要解決 ，估計開發期間會碰到什麼困難，技術方案以後如何升級，對本項目的技術有什麼評價等。
5. 《系統分析》 -- 包括功能實現、模塊組成、功能流程圖、函數介面、數據字典、軟體開發需要考慮的各種問題等。以《需求分析》為基礎，進行詳細的系統分析 ( 產品的開發和實現方法 ) ，估計開發期間需要把什麼問題說明白，程序員根據《系統分析》，開始在項目主管的帶領下進行編碼。
6. 《資料庫文檔》 -- 包括資料庫名稱、表名、欄位名、欄位類型、欄位說明、備注、欄位數值計算公式等。以《系統分析》為基礎，進行詳細的資料庫設計。必要時可以用圖表解說，特別是關系資料庫。
7. 《功能函數文檔》 -- 包括變數名、變數初值、功能，函數名，參數，如何調用、備注、注意事項等。以《系統分析》為基礎，進行詳細的說明，列出哪個功能涉及多少個函數，以便以後程序員修改、接手和擴展。
8. 《界面文檔》 -- 包括軟體外觀、界面素材、編輯工具、文件名、菜單、按鈕和其它界面部件的要求，這里與軟體完成後的運行界面是一致的。
9. 《編譯手冊》 -- 包括伺服器編譯環境、操作系統、編譯工具、 GNU 的 C++ 編譯器版本信息、目錄說明、程序生成、源程序文件列表、 Makefile 配置及其相關程序的對應關系列表。客戶端的編譯過程、編譯結果、編譯示例、編譯環境、操作系統、編譯工具、源文件列表和製作安裝程序的過程。
10. 《 QA 文檔》 -- 包括產品簡介、產品原理、產品功能列表、功能描述、功能流程、執行結果、資料庫結構、測試要求等，提供給軟體測試人員使用。
11. 《項目總結》 -- 包括項目簡介、項目參與人員和開發時間、項目風險管理過程、項目功能列表、項目結構特點、技術特點、對項目的升級建議、對以後的項目的建議、人員素質情況等。 1. 《產品簡介》 -- 包括公司背景、產品概念、適用范圍、產品功能、功能特點、運行要求和公司聯系地址。
2. 《產品演示》 -- 包括公司簡介、產品背景、產品描述、產品特點、產品作用、適用范圍、使用分析、功能模塊、解決問題、合作夥伴、成功案例等。一般用 Power point 或者 VCD 錄制軟體實現。
3. 《疑問解答》 -- 列出用戶關心的問題和處理方法。用於解答軟體的操作功能和解決用戶的疑難問題。
4. 《功能介紹》 -- 以《需求分析》為書寫基礎，包括軟體介紹、軟體結構、功能列表、功能描述和公司聯系地址。
5. 《技術白皮書》 -- 以《技術分析》為書寫基礎，包括功能實現、技術選型、關鍵技術問題的解決、技術方案特點、技術升級方向等。
6. 《評測報告》 -- 第三方權威評測報告。包括評測目的、評測范圍、評測環境、評測內容、實測數據、性能表現、結果分析和評測總結等。
7. 《安裝手冊》 -- 包括系統環境、運行平台、產品安裝過程、初始環境設置、安裝記錄等。
8. 《使用手冊》 -- 包括產品簡介、功能列表、功能描述和解釋、功能操作、客戶服務和聯系方式等。
9. 《維護手冊》 -- 包括產品簡介、系統須知、初始環境設置、系統配置、數據管理和備份、技術問題解答和聯系方式等。
10. 《用戶報告》 -- 包括產品簡介、購買時間、使用目的、使用時間、使用地點、實施過程、出現問題和解決、產品總結和建議等。
11. 《銷售培訓》 -- 包括項目簡介、產品功能、產品特點、商業優勢、系統運行環境、適用范圍、目標客戶等。 第一、需求分析文檔
用戶需求分析文檔是指在和客戶進行溝通時，把用戶所要求的信息記錄下來，根據用戶的要求進行需求分析，規劃出我們要開發的軟體所要實現哪些功能。
第二、概要設計文檔
概要設計：顧名思義，就是對我們所要開發的軟體進行一個整體的概括，把這個軟體所包含的功能模塊作一個設計，以後我們在開發的時候就有目標，有方向了。
第三、系統設計文檔
系統設計，就是對概要的一個詳細的實施，就是分析我們所要開發軟體各大功能模塊中所包含的小模塊，把這些小模塊都一一列舉出來，然後再對軟體開發人員進行有條理的進行開發任務的分配。
第四、詳細設計文檔
詳細設計文檔，主要是把我們每個小模塊，小功能的業務邏輯處理用文字的方式表達出來，讓程序員在編碼的時候有一個依據和參照；同時，在進行詳細文檔設計的時候，有的軟體公司也會根據不同的項目作出相應的《軟體開發代碼規范》性文檔。以保障我們所做工作的統一性。
第五、軟體測試文檔
當我們參照軟體詳細設計文檔編碼完成後，接著就會根據我們所實現的功能，進行軟體測試文檔的編寫；大多測試文檔有兩類，一類是軟體單體測試文檔，一類是軟體結合測試文檔；顧名思義，單體測試：就是對軟體中每個小的方法，一個獨立的方法進行測試的文檔；結合測試：就是把多個功能模塊組合到一起進行測試，主要是為了檢測每個功能模塊之前的交互性和功能的結合實現性。
第六、軟體完成後的總結匯報型文檔
不管所開發軟體的規模大小，在一個軟體開發結束後，我們都會把開發過中的問題和項目開發總結一起記錄下來，以防以後在開發過程中再有類似問題出現，提高我們的開發效率。
根據軟體開發公司的規模、標准和客戶的需求不同，開發文檔的種類和數量也不同，我在這里和大家討論的軟體開發相關文檔都是最基礎的；在軟體行業有一句話：一個軟體能否順利的完成並且功能是否完善，重要是看這個軟體有多少文檔，軟體開發文檔是一個軟體的支柱，如果你的開發文檔漏洞百出，那麼你所開發出來的軟體也不可能會好；開發文檔的好壞可以直接影響到所開發出來軟體的成功與否。

3. JAVA使用或覆蓋了已過時的 API

部分API之所以會過時，是因為該API有BUG或者是有更好的API代替。過時的API你可以到JDK的API文檔去查詢，過時的一般用刪除線劃掉的。

過時的API一般都有另外的API來代替，具體用什麼代替由於沒有確切的例子，需要你自己去API文檔去查。

由四方面組成：

（1）Java編程語言。

（2）Java類文件格式。

（3）Java虛擬機。

（4）Java應用程序介面。

(3)程序員如何寫介面文檔擴展閱讀：

語言特點：

1、簡單性

Java看起來設計得很像C++，但是為了使語言小和容易熟悉，設計者們把C++語言中許多可用的特徵去掉了，這些特徵是一般程序員很少使用的。例如，Java不支持go to語句，代之以提供break和continue語句以及異常處理。

Java還剔除了C++的操作符過載（overload）和多繼承特徵，並且不使用主文件，免去了預處理程序。因為Java沒有結構，數組和串都是對象，所以不需要指針。

Java能夠自動處理對象的引用和間接引用，實現自動的無用單元收集，使用戶不必為存儲管理問題煩惱，能更多的時間和精力花在研發上。

2、面向對象

Java是一個面向對象的語言。對程序員來說，這意味著要注意應中的數據和操縱數據的方法（method），而不是嚴格地用過程來思考。在一個面向對象的系統中，類（class）是數據和操作數據的方法的集合。

數據和方法一起描述對象（object）的狀態和行為。每一對象是其狀態和行為的封裝。類是按一定體系和層次安排的，使得子類可以從超類繼承行為。在這個類層次體系中有一個根類，它是具有一般行為的類。Java程序是用類來組織的。

4. API是什麼意思API文檔又是什麼意思

API（Application Programming Interface,應用程序編程介面）是一些預先定義的函數，目的是提供應用程序與開發人員基於某軟體或硬體得以訪問一組常式的能力，而又無需訪問源碼，或理解內部工作機制的細節。

API文檔是一個技術內容交付文件，包含如何有效地使用和集成api的說明。它是一個簡明的參考手冊，包含了使用API所需的所有信息，詳細介紹了函數、類、返回類型、參數等，並有教程是示例支撐。

API文檔傳統上是使用常規內容創建和維護工具和文本編輯器完成的。API描述格式如OpenAPI /Swagger規范具有自動文檔編制流程，它使得團隊更容易生成和維護API文檔。

(4)程序員如何寫介面文檔擴展閱讀：

Windows API

API函數包含在Windows系統目錄下的動態連接庫文件中。Windows API是一套用來控制Windows的各個部件的外觀和行為的預先定義的Windows函數。用戶的每個動作都會引發一個或幾個函數的運行以告訴Windows發生了什麼。

這在某種程度上很像Windows的天然代碼。而其他的語言只是提供一種能自動而且更容易的訪問API的方法。當你點擊窗體上的一個按鈕時，Windows會發送一個消息給窗體，VB獲取這個調用並經過分析後生成一個特定事件。

更易理解來說：Windows系統除了協調應用程序的執行、內存的分配、系統資源的管理外，同時他也是一個很大的服務中心。

調用這個服務中心的各種服務(每一種服務就是一個函數)可以幫助應用程序達到開啟視窗、描繪圖形和使用周邊設備等目的，由於這些函數服務的對象是應用程序，所以稱之為Application Programming Interface，簡稱API 函數。

WIN32 API也就是MicrosoftWindows 32位平台的應用程序編程介面。凡是在 Windows工作環境底下執行的應用程序，都可以調用Windows API。

linux API

在linux中，用戶編程介面API遵循了UNIX中最流行的應用編程界面標准---POSIX標准。POSIX標準是由IEEE和ISO/IEC共同開發的標准系統。

該標准基於當時現有的UNIX實踐和經驗，描述了操作系統的系統調用編程介面API，用於保證應用程序可以在源程序一級上在多種操作系統上移植運行。這些系統調用編程介面主要是通過C庫（LIBC）來實現的。

5. Android APP開發需求文檔範本是什麼樣的

軟體需求文檔格式的標准寫法x0dx0a1．引言x0dx0a x0dx0a1．1 編寫目的x0dx0a x0dx0a· 闡明開發本軟體的目的；x0dx0a x0dx0a1．2 項目背景x0dx0a x0dx0a· 標識待開發軟體產品的名稱、代碼；x0dx0a x0dx0a· 列出本項目的任務提出者、項目負責人、系統分析員、系統設計員、程序設計員、程序員、資料員以及與本項目開展工作直接有關的人員和用戶；x0dx0a x0dx0a· 說明該軟體產品與其他有關軟體產品的相互關系。x0dx0a x0dx0a1．3 術語說明x0dx0a x0dx0a列出本文檔中所用到的專門術語的定義和英文縮寫詞的原文。x0dx0a x0dx0a1．4 參考資料（可有可無）x0dx0a x0dx0a 列舉編寫軟體需求規格說明時所參考的資料，包括項目經核準的計劃任務書、合x0dx0a x0dx0a同、引用的標准和規范、項目開發計劃、需求規格說明、使用實例文檔，以及相關產品x0dx0a x0dx0a的軟體需求規格說明。x0dx0a x0dx0a 在這里應該給出詳細的信息，包括標題、作者、版本號、發表日期、出版單位或資x0dx0a x0dx0a料來源。x0dx0a x0dx0a2．項目概述x0dx0a x0dx0a 2．1 待開發軟體的一般描述x0dx0a x0dx0a 描述待開發軟體的背景，所應達到的目標，以及市場前景等。x0dx0a x0dx0a 2．2 待開發軟體的功能x0dx0a x0dx0a 簡述待開發軟體所具有的主要功能。為了幫助每個讀者易於理解，可以使用列表或x0dx0a x0dx0a圖形的方法進行描述。使用圖形表示，可以採用：x0dx0a x0dx0a · 頂層數據流圖；x0dx0a x0dx0a · 用例UseCase圖；x0dx0a x0dx0a · 系統流程圖；x0dx0a x0dx0a · 層次方框圖。x0dx0a x0dx0a 2．3 用戶特徵和水平（是哪類人使用）x0dx0a x0dx0a 描述最終用戶應具有的受教育水平、工作經驗及技術專長。x0dx0a x0dx0a 2．4 運行環境x0dx0a x0dx0a 描述軟體的運行環境，包括硬體平台、硬體要求、操作系統和版本，以及其他的軟x0dx0a x0dx0a件或與其共存的應用程序等。x0dx0a x0dx0a 2．5 條件與限制x0dx0a x0dx0a 給出影響開發人員在設計軟體時的約束條款，例如：x0dx0a x0dx0a · 必須使用或避免使用的特定技術、工具、編程語言和資料庫；x0dx0a x0dx0a · 硬體限制；x0dx0a x0dx0a · 所要求的開發規范或標准。x0dx0a x0dx0a3．功能需求x0dx0a x0dx0a 3．1 功能劃分x0dx0a x0dx0a 列舉出所開發的軟體能實現的全部功能，可採用文字、圖表或數學公式等多種方法x0dx0a x0dx0a進行描述。x0dx0a x0dx0a3．2 功能描述x0dx0a x0dx0a對各個功能進行詳細的描述。x0dx0a x0dx0a4．外部介面需求x0dx0a x0dx0a4．1 用戶界面x0dx0a x0dx0a對用戶希望該軟體所具有的界面特徵進行描述。以下是可能要包括的一些特徵：x0dx0a x0dx0a· 將要採用的圖形用戶界面標准或產品系列的風格；x0dx0a x0dx0a· 屏幕布局；x0dx0a x0dx0a· 菜單布局；x0dx0a x0dx0a· 輸入輸出格式；x0dx0a x0dx0a· 錯誤信息顯示格式；x0dx0a x0dx0a建議採用RAD開發工具， 比如Visio，構造用戶界面。x0dx0a x0dx0a4．2 硬體介面x0dx0a x0dx0a 描述系統中軟體產品和硬體設備每一介面的特徵，以及硬體介面支持的設備、軟體與硬體介面之間，以及硬體介面與支持設備之間的約定，包括交流的數據和控制信息的性質以及所使用的通信協議。x0dx0a x0dx0a4．3 軟體介面x0dx0a x0dx0a 描述該軟體產品與其有關軟體的介面關系，並指出這些外部軟體或組件的名字和版本號。比如運行在什麼操作系統上，訪問何種類型的資料庫，使用什麼資料庫連接組件，和什麼商業軟體共享數據等。x0dx0a x0dx0a4．4 通信介面x0dx0a x0dx0a 描述和本軟體產品相關的各種通信需求，包括電子郵件、Web瀏覽器、網路通信協議等。x0dx0a x0dx0a4．5 故障處理x0dx0a x0dx0a 對可能的軟體、硬體故障以及對各項性能而言所產生的後果進行處理。x0dx0a x0dx0a5．性能需求x0dx0a x0dx0a5．1 數據精確度x0dx0a x0dx0a輸出結果的精度。x0dx0a x0dx0a 5．2 時間特性x0dx0a x0dx0a 時間特性可包括如下幾方面x0dx0a x0dx0a ·響應時間；x0dx0a x0dx0a ·更新處理時間；x0dx0a x0dx0a ·數據轉換與傳輸時間；x0dx0a x0dx0a ·運行時間等。x0dx0a x0dx0a 5．3 適應性x0dx0a x0dx0a 在操作方式、運行環境、與其他軟體的介面以及開發計劃等發生變化時，軟體的適應能力。x0dx0a x0dx0a6．其他需求x0dx0a x0dx0a列出在本文的其他部分未出現的需求。如果不需要增加其他需求，可省略這一部分。x0dx0a x0dx0a7．數據描述x0dx0a x0dx0a 7．1 靜態數據x0dx0a x0dx0a 7．2 動態數據x0dx0a x0dx0a包括輸入數據和輸出數據。x0dx0a x0dx0a 7．3 資料庫描述x0dx0a x0dx0a 給出使用資料庫的名稱和類型。x0dx0a x0dx0a 7．4 數據字典x0dx0a x0dx0a對於數據流圖、層次方框圖中出現的所有圖形元素在數據字典中都要作為一個詞條加以定義，使得每一個圖形元素都有唯一的一個清晰明確的解釋。x0dx0a x0dx0a數據字典中所有的定義必須是嚴密的、精確的，不可有二意性。x0dx0a x0dx0a 7．5 數據採集x0dx0a x0dx0a ·列出提供輸入數據的機構、設備和人員x0dx0a x0dx0a ·列出數據輸入的手段、介質和設備；x0dx0a x0dx0a ·列出數據生成的方法、介質和設備。x0dx0a x0dx0a8．附錄x0dx0a x0dx0a 包括分析模型，待定問題圖表等。

6. API是什麼意思

API(Application
Programming
Interface,應用程序編程介面)是一套用來控制Windows的各個部件(從桌面的外觀到為一個新進程分配的內存)的外觀和行為的一套預先定義的Windows函數.用戶的每個動作都會引發一個或幾個函數的運行以告訴Windows發生了什麼.
這在某種程度上很象Windows的天然代碼.其他的語言只是提供一種能自動而且更容易的訪問API的方法.VB在這方面作了很多工作.它完全隱藏了API並且提供了在Windows環境下編程的一種完全不同的方法.
這也就是說,你用VB寫出的每行代碼都會被VB轉換為API函數傳遞給Windows.例如,Form1.Print...VB
將會以一定的參數(你的代碼中提供的,或是默認參數)調用TextOut
這個API函數.
同樣,當你點擊窗體上的一個按鈕時,Windows會發送一個消息給窗體(這對於你來說是隱藏的),VB獲取這個調用並經過分析後生成一個特定事件(Button_Click).
API函數包含在Windows系統目錄下的動態連接庫文件中(如User32.dll,GDI32.dll,Shell32.dll...).
API
聲明
正如在"什麼是API"中所說,API函數包含在位於系統目錄下的DLL文件中.你可以自己輸入API函數的聲明,但VB提供了一種更簡單的方法,即使用API
Text
Viewer.
要想在你的工程中聲明API函數,只需運行API
Text
Viewer,打開Win32api.txt(或.MDB如果你已經把它轉換成了資料庫的話,這樣可以加快速度.注:微軟的這個文件有很多的不足,你可以試一下本站提供下載的api32.txt),選擇"聲明",找到所需函數,點擊"添加(Add)"並"復制(Copy)",然後粘貼(Paste)到你的工程里.使用預定義的常量和類型也是同樣的方法.
你將會遇到一些問題:
假設你想在你的窗體模塊中聲明一個函數.粘貼然後運行,VB會告訴你:編譯錯誤...Declare
語句不允許作為類或對象模塊中的
Public
成員...看起來很糟糕,其實你需要做的只是在聲明前面添加一個Private(如
Private
Declare
Function...).--不要忘了,可是這將使該函數只在該窗體模塊可用.
在有些情況下,你會得到"不明確的名稱"這樣的提示,這是因為函數.常量或其他的什麼東西共用了一個名稱.由於絕大多數的函數(也可能是全部,我沒有驗證過)都進行了別名化,亦即意味著你可以通過Alias子句使用其它的而不是他們原有的名稱,你只需簡單地改變一下函數名稱而它仍然可以正常運行.
你可以通過查看VB的Declare語句幫助主題來獲取有關Alias的詳細說明.
消息(Messages)
好了,現在你已經知道什麼是API函數了,但你也一定聽說過消息(如果你還沒有,你很快就會)並且想知道它是什麼.消息是Windows告訴你的程序發生了哪些事件或要求執行特定操作的基本方法.例如,當用戶點擊一個按鈕,移動滑鼠,或是向文本框中鍵入文字時,一條消息就會被發送給你的窗體.
所有發送的消息都有四個參數--一個窗口句柄(hwnd),一個消息編號(msg)還有兩個32位長度(Long)的參數.
hwnd即要接受消息的一個窗口的句柄,msg即消息的標識符(編號).該標識符是指引發消息的動作類型(如移動滑鼠),另外兩個參數是該消息的附加參數(例如當滑鼠移動時游標的當前位置)
但是,當消息發送給你時你為什麼看不到呢--就象有人在偷你的信一樣?請先別惱火,讓我告訴你.
小偷其實是Visual
Basic.但它並沒有偷走你的信,而是在閱讀了之後挑出重要的以一種好的方式告訴你.這種方式就是你代碼中的事件(Event).
這樣,當用戶在你的窗體上移動滑鼠時,Windows會發送一條WM_MOUSEMOVE消息給你的窗口,VB得到這條消息以及它的參數並運行你在事件MouseMove中的代碼,同時VB會把這條消息的第二個32位數(它包含了x,y坐標,單位為像素(Pixel),每個位16位)轉換為兩個單精度數,單位為緹(Twip).
現在,如果你需要游標坐標的像素表示,然而VB已經把它轉換成了緹,因此你需要重新把它轉換為以像素為單位.在這里,Windows給了你所需要的,但VB"好意地"進行了轉換而使你不得不重新轉換.你可能會問--我難道不能自己接收消息嗎?答案是肯定的,你可以使用一種叫做子類處理(Subclass)的方法.但你除非必須否則最好不要使用,因為這與VB的安全程序設計有一點點的違背.(注:子類處理確實有很大的風險,但如果使用得當,是很有用處的.不過有一點一定要注意,即千萬不要使用VB的斷點調試功能,這可能會導致VB崩潰!)
需要補充說明的是:你可以發送消息給你自己的窗口或其他的窗口,只需調用SendMessage或PostMessage(SendMessage會使接受到消息的窗口立刻處理消息,而PostMessage是把消息發送到一個稱為消息隊列的隊列中去,等候處理(它將會在該消息處理完後返回,例如有些延遲)).你必須制定接受消息的窗口的句柄,欲發送消息的編號(所有的消息的編號均為常量,你可以通過API
Text
Viewer查得)以及兩個32位的參數。
API:應用程序介面(API:Application
Program
Interface)
應用程序介面(API:application
programming
interface)是一組定義、程序及協議的集合，通過
API
介面實現計算機軟體之間的相互通信。API
的一個主要功能是提供通用功能集。程序員通過使用
API
函數開發應用程序，從而可以避免編寫無用程序，以減輕編程任務。
API
同時也是一種中間件，為各種不同平台提供數據共享。根據單個或分布式平台上不同軟體應用程序間的數據共享性能，可以將
API
分為四種類型:
遠程過程調用(RPC):通過作用在共享數據緩存器上的過程(或任務)實現程序間的通信。
標准查詢語言(SQL):是標準的訪問數據的查詢語言，通過通用資料庫實現應用程序間的數據共享。
文件傳輸:文件傳輸通過發送格式化文件實現應用程序間數據共享。
信息交付:指松耦合或緊耦合應用程序間的小型格式化信息，通過程序間的直接通信實現數據共享。
當前應用於
API
的標准包括
ANSI
標准
SQL
API。另外還有一些應用於其它類型的標准尚在制定之中。API
可以應用於所有計算機平台和操作系統。這些
API
以不同的格式連接數據(如共享數據緩存器、資料庫結構、文件框架)。每種數據格式要求以不同的數據命令和參數實現正確的數據通信，但同時也會產生不同類型的錯誤。因此，除了具備執行數據共享任務所需的知識以外，這些類型的
API
還必須解決很多網路參數問題和可能的差錯條件，即每個應用程序都必須清楚自身是否有強大的性能支持程序間通信。相反由於這種
API
只處理一種信息格式，所以該情形下的信息交付
API
只提供較小的命令、網路參數以及差錯條件子集。正因為如此，交付
API
方式大大降低了系統復雜性，所以當應用程序需要通過多個平台實現數據共享時，採用信息交付
API
類型是比較理想的選擇。
API
與圖形用戶介面(GUI)或命令介面有著鮮明的差別:API
介面屬於一種操作系統或程序介面，而後兩者都屬於直接用戶介面。
有時公司會將
API
作為其公共開放系統。也就是說，公司制定自己的系統介面標准，當需要執行系統整合、自定義和程序應用等操作時，公司所有成員都可以通過該介面標准調用源代碼，該介面標准被稱之為開放式
API。
另一種含義:
1:美國石油協會(API:American
Petrolenm
Institute):
API610/682是機械密封的設計和選用標准;
API676
轉子泵的標准;
2:API還有一種含意:空氣污染指數。【英文
air
pollution
index
的縮寫】
空氣污染指數(AIR
POLLUTION
INDEX，簡稱API)是一種反映和評價空氣質量的方法，就是將常規監測的幾種空氣污染物的濃度簡化成為單一的概念性數值形式、並分級表徵空氣質量狀況與空氣污染的程度，其結果簡明直觀，使用方便，適用於表示城市的短期空氣質量狀況和變化趨勢。
空氣污染指數的確定原則:空氣質量的好壞取決於各種污染物中危害最大的污染物的污染程度。空氣污染指數是根據環境空氣質量標准和各項污染物對人體健康和生態環境的影響來確定污染指數的分級及相應的污染物濃度限值。目前我國所用的空氣指數的分級標準是:(1)空氣污染指數(API)50點對應的污染物濃度為國家空氣質量日均值一級標准;(2)API100點對應的污染物濃度為國家空氣質量日均值二級標准;(3)API200點對應的污染物濃度為國家空氣質量日均值三級標准;(4)API更高值段的分級對應於各種污染物對人體健康產生不同影響時的濃度限值，API500點對應於對人體產生嚴重危害時各項污染物的濃度。
根據我國空氣污染的特點和污染防治工作的重點，目前計入空氣污染指數的污染物項目暫定為:二氧化硫、氮氧化物和總懸浮顆粒物。隨著環境保護工作的深入和監測技術水平的提高，再調整增加其它污染項目，以便更為客觀地反應污染狀況。
空氣污染指數的計算與報告:
污染指數與各項污染物濃度的關系是分段線性函數(見表1和圖1)，用內插法計算各污染物的分指數In(具體計算方法請參見《環境監測簡報》1997年第9期)，取各項污染物分指數中最大者代表該區域或城市的污染指數。即:API=max(I1,I2···Ii,···In)
該指數所對應的污染物即為該區域或城市的首要污染物。當污染指數API值小於50時，不報告首要污染物。
3:在JAVA中，API除了有應用「程序程序介面」的意思外，還特指JAVA
API的說明文檔，也稱為JAVA幫助文檔。
4.API
Q1質量體系認證是您向用戶證明您有一套API認可的完善的質量管理體系,
有些石油、天然氣設備製造商所生產的產品目前沒有所適用API會標產品的規范對應，
但他們又想向用戶證明他們的產品或服務符合API標準的要求，所以API
Q1質量體系認證可以幫您辦到。API
Q1質量體系認證特別適用於那些所生產的產品沒有相應的API會標產品規范所對應的石油、天然氣設備生產廠家，
或向石油、天然氣行業提供服務的公司。
5.原料葯(Active
Pharmaceutical
Ingredients):
指的是葯物活性成分，也就是我們通常所說的原料葯。
另一種含義:
使用API(應用編程介面，英文全稱:Application
Programming
Interface)構建業務是實現開放式業務結構的關鍵技術，也是下一代網路區別於傳統電信網的主要特點之一。目前，關於下一代網路的開放式業務API標准主要包括:由Parlay組織、3GPP和ETSI
SPAN共同制定的Parlay/OSA
API以及由SUN公司在Java平台上推出的JAIN
API。
Parlay
API是由Parlay組織定義的便於業務開發者快速創建電信業務的應用編程介面，自1999年成立以來，Parlay組織已制定了4個版本的Parlay協議。開放式業務結構(OSA)是3GPP制定的多媒體業務框架，選定Parlay作為其開放式業務介面API。兩者結合的Parlay/OSA
API獨立於具體的實現技術，可以應用於固定網路、移動網路以及下一代網路的業務提供;獨立於具體的實現語言，可以用C、C++、Java等各種語言實現;定義了完善的認證和授權機制，以支持對第3方應用的支持。
Parlay/OSA
API位於由網路運營商管理的Parlay網關和由業務提供商管理的應用伺服器之間。Parlay網關對應用伺服器屏蔽了下層網路的技術實現細節，使得應用伺服器可以使用統一的方式對網路能力進行訪問。
Parlay/OSA
API包括兩類介面:業務介面和框架介面。業務介面提供應用訪問網路能力和信息的介面，框架介面提供業務介面安全、管理所必需的支持能力。業務介面保證用戶能夠接入傳統網路，如呼叫控制、呼叫管理、發送消息、用戶交互等;框架介面提供的功能有:業務登記、業務預訂、業務發現、認證、授權和綜合管理。
JAIN
API和Parlay/OSA
API設計思想相近，功能上具有互補性。它採用專一的Java語言實現，並且定義了比較完備的訪問各種網路的網路協議API。目前Parlay/JAIN聯合工作組正在進行兩者的融合工作。
API:醫葯活性物原料葯