You can deploy APIs with Wolfram Web Engine (WWE) either with Mathematica or by manually placing the API code into the Tomcat directory structure.

Please ensure you have already installed WWE:

• How do I install Wolfram Web Engine on Windows?
• How do I install Wolfram Web Engine on macOS?
• How do I install Wolfram Web Engine on Linux?

Deploying an API with Mathematica

Deploying the API

1. Add the following line to the /conf/tomcat-users.xml file in the Tomcat installation directory to define a username and password for a Tomcat deployment user.

   <user username="username_of_choice" password="strong_password_of_choice" roles="deploy"/>

2. Open a new Mathematica notebook.
3. Connect to your WWE server using ServiceConnect and store the returning ServiceObject in a variable:

   so = ServiceConnect["WolframWebEngine", "http://localhost:8080/webengine"]

   You will be prompted to enter the username and password for the Tomcat deployment user you defined in step 1.

4. Use ServiceDeploy to deploy your API function, such as:

   ServiceDeploy[so, APIFunction["s" -> "String", StringReverse[#s] &], "myAPI"]

Testing the Deployed API

1. Click the link in the ServiceDeploy output cell. This opens the API in a web browser.
2. Append ?s=myString to the end of the URL to reverse “myString”.

   http://localhost:8080/webengine/active/myAPI?s=myString

   The API was deployed successfully if you see “gnirtSym” on the screen.

Deploying an API Manually

Deploying the API

1. Create a subdirectory with your desired API name, such as “myAPI”, in webapps/webengine/active in the Tomcat installation directory.
2. In that subdirectory, create a file named “index.wl”.
3. Enter your Wolfram Language API code into the index.wl file, such as:

   APIFunction["s" -> "String", StringReverse[#s] &]

Testing the Deployed API

4. Enter your API’s URL into a web browser, such as:

   http://localhost:8080/webengine/active/myAPI?s=myString

   The API was deployed successfully if you see the reversed string “gnirtSym” on the screen.

If you receive an error, please contact server-support@wolfram.com.