程序员如何写接口文档

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:医药活性物原料药