使用 Swagger/OpenAPI 的数据 API 生成器 REST API 文档
OpenAPI 规范是用于记录 HTTP API 的编程语言不可知的标准。 数据 API 生成器支持 OpenAPI 标准，它能够：
- 生成有关已启用 REST 的所有运行时配置定义的实体的信息。
- 将信息编译为与 OpenAPI 架构匹配的格式。
- 通过可视化 UI (Swagger) 或序列化文件公开生成的 OpenAPI 架构。
OpenAPI 说明文档
数据 API 生成器使用提供的运行时配置和定义的每个已启用 REST 的实体的数据库对象元数据生成 OpenAPI 说明文档。 架构文件是使用 OpenAPI.NET SDK 提供的功能生成的。 目前，架构文件是按照格式化为 JSON 的 OpenAPI 规范 v3.0.1 生成的。
可以从路径从数据 API 生成器提取 OpenAPI 说明文档：
GET /{rest-path}/openapi
注意
默认情况下，该值 rest-path 为 api ，并且是可配置的。 有关详细信息，请参阅 REST 配置
SwaggerUI
Swagger UI 提供了基于 Web 的 UI，它使用生成的 OpenAPI 规范提供有关服务的信息。
在 Development 模式下，数据 API 生成器允许从专用终结点查看生成的 OpenAPI 说明文档：
GET /swagger
为了避免与运行时配置的实体发生命名冲突，“Swagger”终结点不会嵌套在 下 rest-path 。