什么是 OpenAPI 3.x

OpenAPI 是描述 RESTful API 的行业标准规范。原名 Swagger,它支持自动代码生成、文档生成和测试。

API 标准

OpenAPI 提供描述 HTTP API 的机器可读格式,使工具能够自动生成代码、文档和测试套件。

Swagger 起源

Swagger 1.x 和 2.x 奠定了 API 描述格式的基础。该规范于 2015 年捐赠给 OpenAPI Initiative,并演进为 OpenAPI 3.x。

OpenAPI 3.x

当前标准支持 JSON 和 YAML 格式、高级模式定义、多种身份验证方案、Webhook 以及操作之间的链接。

Delphi 集成

sgcOpenAPI 解析任何 OpenAPI 或 Swagger 规范并生成原生 Object Pascal 代码 — 为 Delphi 开发者提供一流的 API 工具。

规范描述的内容

端点和操作

路径、HTTP 方法(GET、POST、PUT、DELETE)、查询参数、请求头和请求体均以结构化格式定义。

模式和模型

数据类型、对象属性、数组、枚举和组合(allOf、oneOf、anyOf)描述请求和响应有效载荷的形状。

身份验证

API 密钥、OAuth 2.0 流程、HTTP Bearer 令牌和 OpenID Connect 被定义为可重用的安全方案,应用于各操作。

将 OpenAPI 引入 Delphi

从任何 OpenAPI 规范生成原生 Pascal SDK。