Deploy REST services
- Last Updated: February 5, 2024
- 1 minute read
- OpenEdge
- Version 12.2
- Documentation
To deploy a REST service, deploy the .paar
file to an existing web application like ROOT, or whichever ABL web application requires
the service.
The deployREST command-line tool adds REST services to a deployed ABL web
application (oeabl.war). After you deploy the service,
stop and restart the instance to run the new service.
To deploy REST services to an ABL web application for an existing instance, perform the following steps:
- Obtain the
.paarfile and any ABL r-code that supports the API for the service interface from the developer. - Move r-code to the PROPATH.
- Navigate to the /bin directory of the instance.
- Use the deploySOAP command to deploy the
.paarfile to the ABL web application:deployREST.[bat|sh] path_to_rest/RESTservice.paar ABLwebapp - Stop and restart the Progress Application Server (PAS) for OpenEdge instance.
Secure REST services
If deploying to a production environment, be sure to secure the REST endpoints of
your services. Out of the box, the login model (the
client.login.model property in the
oeablSecurity.properties file) is set to
anonymous (the lowest security level) allowing anyone access.
The property should be changed to restrict access. For more information, see Enable ABL application authentication.
Test and validate REST services
Progress provides a way to view the available REST services in a JSON format specific to OpenEdge. For more information, see JSON documentation for REST-based services.
Undeploy REST services
-undeploy option specified, for
example:
|