2.6. MicroProfile OpenAPI

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

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

注意

目前，虚拟主机的 OpenAPI 端点只能记录单个部署。要将 OpenAPI 与同一虚拟主机上不同上下文路径注册的多个部署搭配使用，每个部署都必须使用不同的端点路径。

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

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