这篇文档,介绍了如何查看Wowza Streaming Engine的Http Rest API接口。
注意:
- 要学习如何使用cURL向Wowza Streaming Engine发起REST请求,请阅读如何用cURL向Wowza Streaming Engine发起REST请求 以及我们的REST API 请求示例,这些资料演示了如何请求Wowza Streaming Engine的REST 服务来执行一些常见的任务。
一、启用 Wowza Streaming Engine REST API documentation 服务
在您完成Wowza Streaming Engine 的安装后,你只需要修改一处配置就可以查看 REST API 文档。
-
用文本编辑器打开[install-dir]/conf/Server.xml文件,搜索“DocumentationServerEnable”,(它一般在第28行左右)。 找到后作如下修改:
<DocumentationServerEnable>false</DocumentationServerEnable>
改为:<DocumentationServerEnable>true</DocumentationServerEnable>
-
(可选) 修改 REST API documentation 服务的端口:
<DocumentationServerPort>8089</DocumentationServerPort>
改为:<DocumentationServerPort>[port-number]</DocumentationServerPort>
- 重启Wowza Streaming Engine。
二、查看REST API 文档
接下来,就可以通过swagger来查看API。首先下载它。
- 1. 下载静态页面及web资源的zip压缩包RESTAPIDocumentationWebpage.zip.
- 2. 将zip包做解压,用浏览器打开[package-root]/index.html文件。
-
3. 在index.html页面的右上角,输入Wowza Streaming Engine的REST API document servlet 服务的URL: (默认情况下,打开时它已经给你输入好了)
http://[wowza-ip-address]:8089/api-docs
注意: 默认情况下,这个URL为http://localhost:8089/api-docs。 如果是要访问远端的一个Wowza服务器上的REST API document serlvet,请按下面操作:
-
在Wowza Streaming Engine 服务器上,用一个文本编辑器打开[install-dir]/conf/Server.xml文件,然后将你的远端电脑的IP地址添加在<RESTInterface>/<IPWhiteList>参数中。
- 重启Wowza Streaming Engine,让修改生效。
-
在你的远端电脑上,在index.html页面,输入Wowza Streaming Engine的 REST API document 服务的URL:
http://[wowza-ip-address]:8089/api-docs
-
在Wowza Streaming Engine 服务器上,用一个文本编辑器打开[install-dir]/conf/Server.xml文件,然后将你的远端电脑的IP地址添加在<RESTInterface>/<IPWhiteList>参数中。
- 点击Explore。
然后,你找到你需要的API,在Swagger UI 上有一个Try it out!按钮,你可以点击它来测试Wowza的REST API。