How to use Wowza Streaming Engine REST API reference documentation with Swagger Codegen

Swagger Codegen is an open-source, template-driven engine that lets you generate API client libraries, server stubs, and documentation from a Swagger specification. Learn how to configure the Wowza Streaming Engine™ media server software's Swagger documentation servlet to work with Codegen.

Note: Wowza Streaming Engine 4.5.0 or later is required.

  1. Follow the Swagger.io installation instructions to download and install Codegen. Make sure Codegen is working before continuing.
  2. On the computer that's running Wowza Streaming Engine and the reference documentation servlet, navigate to [install-dir]/conf and open Server.xml in a text editor.
  3. Locate the <DocumentationServerAuthenticationMethod> property in the <RESTInterface> section.
  4. Add the <DocumentationServerBasePath> and <DocumentationServerRemoveRequestPath> properties immediately after the <DocumentationServerAuthenticationMethod> property, like this:
<DocumentationServerBasePath>/</DocumentationServerBasePath> 
<DocumentationServerRemoveRequestPath>swagger.json/</DocumentationServerRemoveRequestPath>
  1. Save your change.
  2. Restart Wowza Streaming Engine.
  3. In a Command Prompt or Terminal window, run the following command to generate a PHP client to access the Wowza Streaming Engine REST API Swagger servlet:
java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i http://[wowza-ip-address]:8089/swagger.json -l php -o phpCodeOutputFolder/

The command generates the PHP code to access the Wowza Streaming Engine REST API and places the results in the phpCodeOutputFolder.

For more information on working with Codegen, see Getting Started in the Swagger Codegen GitHub project.


If you're having problems or want to discuss this article, post in our forum.