3.7.4. 配置 JBoss EAP 以提供静态 OpenAPI 文档

配置 JBoss EAP 以提供静态 OpenAPI 文档,描述主机的 REST 服务。

当 JBoss EAP 配置为提供静态 OpenAPI 文档时,将在任何 Jakarta RESTful Web 服务和 MicroProfile OpenAPI 注释之前处理静态 OpenAPI 文档。

在生产环境中,在提供静态文档时禁用注释处理。禁用注解处理可确保客户端可以使用不可变和版本化的 API 合同。

流程

  1. 在应用程序源树中创建目录:

    $ mkdir APPLICATION_ROOT/src/main/webapp/META-INF

    APPLICATION_ROOT 是含有应用的 pom.xml 配置文件的目录。

  2. 查询 OpenAPI 端点,将输出重定向到文件中:

    $ curl http://localhost:8080/openapi?format=JSON > src/main/webapp/META-INF/openapi.json

    默认情况下,端点提供 YAML 文档 format=JSON 指定返回 JSON 文档。

  3. 配置应用程序,以便在处理 OpenAPI 文档模型时跳过注解扫描:

    $ echo "mp.openapi.scan.disable=true" > APPLICATION_ROOT/src/main/webapp/META-INF/microprofile-config.properties
  4. 重新构建应用程序:

    $ mvn clean install
  5. 使用以下管理 CLI 命令再次部署应用程序:

    1. 取消部署应用程序:

      undeploy microprofile-openapi.war
    2. 部署应用程序:

      deploy APPLICATION_ROOT/target/microprofile-openapi.war

JBoss EAP 现在在 OpenAPI 端点上提供静态 OpenAPI 文档。