2.6. MicroProfile OpenAPI

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

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

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

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