OpenAPI 规范(前称 Swagger 规范)是用于描述、生成、使用和可视化 RESTful Web 服务的机器可读接口文件规范。它于 2016 年从 Swagger 框架中分离,成为独立项目,由 Linux 基金会的开源合作项目 OpenAPI Initiative 监管。Swagger 和其他一些工具可以根据接口文件生成代码、文档和测试用例。
基于 OpenAPI 接口文件实现的应用程序可以自动生成方法、参数和模型的文档。这有助于保持文档、客户端库和源代码的同步。
已发布新的 OpenAPI WebService(目前为 BETA 版),它读取 JSON 格式的 OpenAPI 3.0 规范并自动创建原生 Pascal 代码的 Delphi 客户端。WebService 会创建一个演示,展示如何与 API 交互。
WebService 要求规范为 3.0+ 版本且为 JSON 格式。
导入 OpenAPI 规范
第一步是导入 OpenAPI 3.0 规范。为此,我将使用 abstractapi.com 用于检索 IP 地址位置的简单 OpenAPI 规范。以下是规范文件:
获得 JSON 格式的 OpenAPI 3.0 规范后,您可以使用我们的 OpenAPI WebService 生成所需的 Delphi 文件,请访问以下网址:
https://www.esegece.com/products/openapi/ws/demo
只需设置类名(默认为 TsgcOpenAPI_Test)并上传规范文件(请先解压!必须为 JSON 格式)。最后按 Upload 按钮处理文件。
如果处理成功,将下载一个包含编译演示的新压缩文件。
测试 OpenAPI 演示
在测试演示之前,您必须在 abstractapi.com 创建免费账户以获取 API 密钥。
https://app.abstractapi.com/users/signup
解压下载的文件并进入 Demo 文件夹,您将找到 sgcOpenAPIDemo.exe 文件,执行它。
将显示一个新表单,展示 Abstractapi.com 的 URL。

点击下一步按钮并选择方法 Retrieve_the_location_of_an_IP_address,填写 Api_Key 和要搜索的 IP 地址。如果请求处理成功,将返回包含 IP 地址信息的 JSON 消息。

以下是 sgcOpenAPI WebService 自动生成的压缩文件,用于测试。
