2.5. MicroProfile OpenAPI

MicroProfile OpenAPI 使用 microprofile-openapi-smallrye 子系统在 JBoss EAP 中集成。

MicroProfile OpenAPI 规范定义提供 OpenAPI 3.0 文档的 HTTP 端点。OpenAPI 3.0 文档描述了主机的 REST 服务。OpenAPI 端点使用配置的路径注册，例如 http://localhost:8080/openapi，位于与部署关联的主机的 root 中。

OpenAPI 端点默认返回一个 YAML 文档。您还可以使用 Accept HTTP 标头或格式查询参数来请求 JSON 文档。

如果给定应用的 Undertow 服务器或主机定义了 HTTPS 侦听器，则使用 HTTPS 提供 OpenAPI 文档。例如，HTTPS 的端点是 https://localhost:8443/openapi。