OpenAPI 规范是一种与语言无关的标准,用于记录 HTTP API。 数据 API 生成器支持 OpenAPI,方法是:
- 为运行时配置中定义的所有已启用 REST 的实体生成元数据
- 将该元数据编译为有效的 OpenAPI 架构
- 通过可视化用户界面(Swagger)或序列化 JSON 文件暴露架构
OpenAPI 说明文档
数据 API 生成器使用运行时配置和每个已启用 REST 的实体的数据库元数据生成 OpenAPI 说明文档。
该架构是使用 OpenAPI.NET SDK 构建的,符合 OpenAPI 规范 v3.0.1。 它作为 JSON 文档输出。
可以在以下位置访问 OpenAPI 文档:
GET /{rest-path}/openapi
[!注意] 默认情况下,
rest-path
是api
。 此值是可配置的。 有关详细信息,请参阅 REST 配置 。
Swagger UI
Swagger UI 根据 OpenAPI 架构提供基于 Web 的 API 的交互式视图。
在 Development
模式下,数据 API 生成器会在以下位置显示 Swagger UI:
GET /swagger
此终结点未嵌套在 rest-path
以下位置,以避免与用户定义的实体冲突。