37、API开发与桌面小部件：拓展应用功能的有效途径

API开发与桌面小部件：拓展应用功能的有效途径

1. API开发的关键要点

1.1 接口定义的重要性

在API开发中，最重要的关注点并非模型或代码，而是API的用户。每个API实际上有两类用户：开发者和远程计算机，因此良好的接口定义至关重要。定义API可以采用自下而上或自上而下的方法，具体取决于API的暴露方式。

采用Web服务为Web应用提供API的开发者，可从API的控制器代码自动生成WSDL文件。WSDL（Web服务描述语言）是一种标准方式，用于表达Web服务上可用的方法调用以及每个调用的输入和输出。API用户可下载此文件，生成代理对象，无需手动编写通信代码。这种服务定义方法通常是自下而上的，因为服务定义是为了反映代码而生成的。当然，WSDL文件应始终附带清晰的、人类可读的文档。

而自行开发基于HTTP的服务的开发者，通常采用自上而下的方法进行服务描述，先编写文档，再创建匹配的实现。由于无法生成正式的服务定义，API描述的清晰性和精确性至关重要。为使用户能正确与服务交互，需要清晰描述所需的HTTP命令、参数编码方式、可能的结果枚举以及结果的交付格式。以可演变为官方API文档的格式开始初步设计草图是有利的，这样可以同时解决两项任务。

1.2 Stax API示例

以Stax概念为例，构建一个简单的API，使第三方软件能够将图像上传到Stax库。上传的不仅是简单的图像，而是Stax内成熟的可重用“概念”，具有名称、描述、标签和图像文件。

1.2.1 编写文档

由于Stax API并非基于Web服务，采用自上而下的方法，首先编写文档：
1. 创建一个排版精美的