在 Liberty 服务器上发现 REST API 文档

您可以使用 API 发现功能部件来发现 Liberty 服务器上的 REST API 文档,以了解哪些 REST API 可用。可以使用 Swagger 用户接口来调用可用的 REST 端点。

过程

  1. 在您要查找其可用 REST API 的 Liberty 服务器的 server.xml 文件中,将 apiDiscovery-1.0 功能部件添加至功能部件管理器。

    apiDiscovery-1.0 功能部件在产品中启用 REST API 发现捆绑软件。此功能部件还会展示 JMX 之类的 Liberty REST 端点(如果服务器配置使用 restConnector-1.0 功能部件)和集合体(如果服务器配置使用 collectiveController-1.0 功能部件)中的文档。

    Liberty 集合体控制器服务器上启用的 apiDiscovery-1.0 功能部件在控制器及其启用了 apiDiscovery-1.0 功能部件的成员服务器上查找可用的 REST API。

    确保服务器配置具有所部署应用程序需要的所有功能部件,例如,servlet-3.0、jsp-2.2 等等。还应确保端口和用户注册表设置对于所部署应用程序而言是正确的。

    以下 server.xml 文件具有 apiDiscovery-1.0 功能部件:

    <server>
        <featureManager>
            <feature>apiDiscovery-1.0</feature>
        </featureManager>
    
        <httpEndpoint id="defaultHttpEndpoint"
                      		host="*"
                      httpPort="8010"
                      httpsPort="8020"/>
    
        <keyStore id="defaultKeyStore" password="Liberty"/>
      
        <basicRegistry id="basic" realm="ibm/api">
            <user name="bob" password="bobpwd" />
        </basicRegistry>
    </server>
  2. 展示 Liberty REST 端点中的 Swagger 2.0 文档。

    可通过以下两种方式中的任何一种配置 API 文档的位置:

    • 使用 SPI com.ibm.wsspi.rest.api.discovery.APIProvider 接口的 getDocument 方法。

      getDocument 方法允许扩展功能部件中的 OSGi 捆绑软件将 REST API 文档添加至整体“主控项”文档。对于此发行版,唯一受支持 DocType 为 DocType.Swagger_20_JSON 和 DocType.Swagger_20_YAML。此接口的实现者可将序列化 JSON 或 YAML 文档返回为 java.lang.String 值,或者可以将文件引用(带有前缀 file:///)传递至 JSON 或 YAML 文件位置。

    • 使用所部署 Web 应用程序。

      每个 Web 模块可继续自己的 REST API 文档。企业应用程序 (EAR) 文件内部的多个 WAR 文件可具有不同 Swagger 2.0 文档。

      公开 Web 模块文档的最简单方法是将 swagger.json 或 swagger.yaml 文件包含在对应的 META-INF 文件夹中。部署应用程序期间,API 发现功能部件会针对每个 Web 模块查找 META-INF/swagger.json 值。如果找不到 META-INF/swagger.json 值,那么 API 发现功能部件将查找 META‐INF/swagger.yaml 值。

      展示 Web 模块的 REST API 文档的另一方法是在 server.xml 配置文件中进行。将每个 Web 模块的 webModuleDoc 元素放置在父 apiDiscovery 元素中;例如:

      <apiDiscovery>
         <webModuleDoc contextRoot="/30ExampleServletInEar" enabled="true" docURL="/swagger.json" />	
         <webModuleDoc contextRoot="/22ExampleServlet" enabled="false" />
         <webModuleDoc contextRoot="/custom" enabled="true" docURL="http://petstore.swagger.io/v2/swagger.json" />
      </apiDiscovery>

      webModuleDoc 元素必须具有 contextRoot 属性,此属性唯一标识您要展示其文档的 Web 模块。

      可选属性 enabled 用于对 Web 模块开启和关闭 API 发现。此属性的缺省值为 true。

      docURL 属性指定用于查找 Web 模块文档的位置。docURL 值可以正斜杠 (/) 开头,以使 URL 相对于上下文根;例如,/30ExampleServletInEar/swagger.json。docURL 值也可以 http 或 https 开头,以表示用于标识文档完整位置的绝对 URL。

      如果 Web 应用程序未提供 swagger.json 或 swagger.yaml 文件,并且应用程序包含 JAX-RS 注释资源,那么可以自动生成 Swagger 文档。服务器配置必须具有 apiDiscovery-1.0 功能部件及 jaxrs-1.1 或 jaxrs-2.0 功能部件;例如:
      <featureManager>
          <feature>apiDiscovery-1.0</feature>
          <feature>jaxrs-1.0</feature>
      </featureManager>
      产品将扫描 Web 应用程序中的所有类以查找 JAX-RS 和 Swagger 注释(搜索带有 @Path、@Api 和 @SwaggerDefinition 注释的类)。产品还将在 Web 应用程序部署或启动期间自动生成相应的 Swagger 文档。

      还可以使用 apiDiscovery-1.0 功能部件来将先前生成的文档与注释扫描期间找到的文档进行合并。产品在 Web 模块中搜索 META-INF/stub/swagger.json 或 META-INF/stub/swagger.yaml 文件。如果功能部件找到这两个文件其中的任何一个,那么它将生成包含该文件内容以及 Web 模块中所有 JAX-RS 和 Swagger 注释的 Swagger 文档。可以使用此功能部件来记录非 JAX-RS servlet,因为该文档将自动与 JAX-RS 部分合并。

      如果 context_root/swagger.json 不可用,那么 API 发现功能部件会将所有可用 context_root/swagger.yaml 放置到从 /ibm/api/docs 和 /ibm/api/explorer 汇总的文档中。apiDiscovery-1.0 功能部件实际上可以处理 swagger.json 或 swagger.yaml,这表示,如果 Web 应用程序的 server.xml 文件配置了 docURL 属性、META-INF 文件夹中的 swagger.json 或 swagger.yaml 文件或 JAX-RS 和 Swagger 注释,那么对 context_root/swagger.json 或 context_root/swagger.yaml 的调用将以所请求 JSON 或 YAML 格式返回另一配置的文档。

  3. 发现 API 文档。

    配置 API 文档的位置后,可通过以下方式发现该文档:

    • 使用 GET https://host:https_port/ibm/api/docs 端点。

      此端点提供有效 Swagger 2.0 文档,其所有可用 Liberty REST API 已合并至单个文档。对于要通过程序浏览可用 API 集的使用者应用程序(例如,API 管理解决方案),这很有用。包含带有 application/yaml 值的可选 Accept 头可以提供 YAML 格式的 Swagger 2.0 文档。此端点有一个名为 root 的可选多基数查询参数,此参数可用于过滤所发现的上下文根。例如,对 GET https://host:https_port/ibm/api/docs?root=/myApp 的调用将检索仅具有 myApp 上下文根的文档的 Swagger 2.0 文档。

    • 使用 GET https://host:https_port/ibm/api/explorer 端点。

      此端点提供富吸引力的已渲染 HTTP 页面来显示 /ibm/api/docs URL 中的内容。此页面遵循标准在线样本 (http://petstore.swagger.io/) 的模式,所以用户可调用 REST API。此端点帮助您探查 Liberty 服务器上的可用 REST API,并且可能会从页面调用这些 API。页面上的过滤器输入框允许使用上下文根的逗号分隔列表来过滤内容。此过滤的工作方式与 root 查询参数类似。可以通过提供所需的输入值并单击“尝试”按钮来测试 API。

    • 对于集合体控制器,请使用 GET https://host:https_port/ibm/api/collective/docs 端点。

      集合体控制器上的此端点提供有效 Swagger 2.0 文档,集合体控制器及其启用了 apiDiscovery-1.0 功能部件的成员中的可用 REST API 已合并至单个文档。对于要通过程序浏览可用 API 集的使用者应用程序(例如,API 管理解决方案),这很有用。包含带有 application/yaml 值的可选 Accept 头可以提供 YAML 格式的 Swagger 2.0 文档。此端点具有两个多基数可选查询参数,它们分别名为 root 和 serverID。

      查询参数 root 可过滤所发现上下文根。例如,对 GET https://host:https_port/ibm/api/collective/docs?root=/myApp 的调用将检索仅具有 myApp 上下文根的文档的 Swagger 2.0 文档。

      查询参数 serverID 可过滤 Liberty 服务器中的可用 REST API。serverID 的格式为 hostName、userDir 和 serverName。此格式提供主机名,主机名后依次跟有逗号 (,)、安装目录、逗号 (,) 和服务器名称。例如,对 GET https://host:https_port/ibm/api/collective/docs?serverID=samplehost.com:8020,/users/admin/wlp/usr,server1 的调用将检索 Swagger 2.0 文档,该文档仅包含具有指定 serverID 的 Liberty 服务器中的可用 REST API。

    • 对于集合体控制器,请使用 GET https://host:https_port/ibm/api/collective/explorer 端点。

      集合体控制器上的此端点提供富吸引力的已渲染 HTTP 页面来显示 /ibm/api/collective/docs URL 中的内容。此端点帮助您探查整个集合体上的可用 REST API,并且可能会从页面调用这些 API。页面上的过滤器输入框允许使用上下文根和服务器标识的逗号分隔列表来过滤内容。服务器标识的格式为 "hostName,userDir,serverName"。必须为服务器标识添加引号 (")。如果要使用“尝试”按钮测试 API,那么您需要在成员服务器的 server.xml 中设置跨源请求共享 (CORS)。

      例如,提供 API“/IBMJMXConnectorREST/mbeanCount”的成员服务器的 server.xml 中,需要以下片段:

      <cors domain="/IBMJMXConnectorREST/mbeanCount"
                allowedOrigins="https://<controller_hostname>:<https_port>"
                allowedMethods="GET,POST,DELETE,PUT,PATCH,OPTIONS"
      		  allowedHeaders="Content-Type,api_key,Authorization"
      		  allowCredentials="true"
              />

      有关设置 CORS 的更多信息,请参阅在 Liberty 服务器上配置跨源请求共享。

      注: CORS 需求仅适用于 Swagger UI 的集合体版本 (https://host:https_port/ibm/api/collective/explorer)。
    启用 apiDiscovery-1.0 功能部件后,ObjectName 值为 WebSphere:feature=apiDiscovery,name=APIDiscovery 的管理 bean (MBean) 在 Liberty MBeanServer 中注册。此 MBean 提供以下属性:
    • DocumentationURL 属性是 /ibm/api/docs 端点的完整 URL,它显示原始 JSON 或 YAML 文档。
    • ExplorerURL 属性是 /ibm/api/explorer 端点的完整 URL,它显示文档的呈现 UI。

    可以使用此 MBean 来了解 REST API 发现是否已启用以及客户机可以在何处访问该功能部件。


用于指示主题类型的图标 任务主题



时间戳记图标 最近一次更新时间: Friday, 16 September 2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-dist&topic=twlp_api_discovery
文件名:twlp_api_discovery.html