Adding a Web Service

Adding a Web Service to a Project

You can can deploy your own web service by adding a WAR file (except a LiveView WAR file) as a Maven dependency in your application or fragment project's pom.xml file, such as eventflow-engine, java-engine and liveview-engine, and so on. For example:


When the web server starts (which occurs by default when the node is started), it automatically scans the class path and deploys the WAR files in it as web service. The address of that web service will be http://<host-address>:<host-name>/<artifactId>. For example: http://localhost:8008/wsapp.

For the web services that you create, best practice is to put the API documentation into WEB-INF/classes/apidoc/ directory. Once the web server starts, it automatically scans that directory and displays the found interactive API documentation in the server-integrated Swagger-UI.

Assigning a Web Service to an Authentication Realm

You can specify an optional binding between a web service name and authentication realm name, including web services that you created. The binding provides a means to override the default node administration authentication realm (which is default-realm) for a specified web service. See Web Server and Web Services Configuration.