Red Hat Bugzilla – Bug 988343
REST API root should not throw an exception, but offer a basic help
Last modified: 2016-09-20 01:06:23 EDT
When accessing an address http://localhost:8080/business-central/rest I get an ugly exception: FAILURE /business-central/rest Could not find resource for relative : /business-central/rest of full path: http://localhost:8080/business-central/rest org.jboss.resteasy.spi.NotFoundException: Could not find resource for relative : /business-central/rest of full path: http://localhost:8080/business-central/rest at org.jboss.resteasy.core.registry.RootSegment.matchChildren(RootSegment.java:360) at ... The root of the REST API and perhaps other REST API incomplete URLs should rather offer a basic navigation and list of available commands like in this wiki: https://github.com/mrietveld/droolsjbpm-integration/wiki/Rest-API BRMS 5.3.x business central REST API was able to offer a basic help, so this can be considered a regression.
Good idea, Jiri.
Setting to new, so that I can tell which bz's are modified ("ASSIGNED") and which aren't ("NEW").
Marco, might be of use - I added something similar for execution server (lie-wb without UI) that for the root of the application will show simple table with REST operations Here you can find the jsp page that shows the operations (it's built based on the rest wiki) https://github.com/droolsjbpm/kie-wb-distributions/blob/master/kie-wb/kie-wb-webapp/src/main/webapp/rest-api.jsp and here is how it binds to the web application https://github.com/droolsjbpm/kie-wb-distributions/blob/master/kie-wb/kie-wb-distribution-wars/src/main/eap6_1/WEB-INF/web-exec-server.xml#L76
Internal Whiteboard: Beta Blocker → Blocker Not critical for Beta, but need to address for GA
This issue still persists in BPMS 6.0.2.CR2. As Maciej mentions, exec-server profile of business central already has such basic help screen for REST operations.
Work is being done to add swagger-ui to BPMS and BRMS.
I have checked with BPMS 6.1.0.DR3 and on page http://localhost:8080/business-central can be seen a help page listing basic REST API commands. However the reported page http://localhost:8080/business-central/rest still shows the same error as in bug description. New basic help screen in exec-server profile definitely improved the situation, but is there more work to be done? What is meant by swagger-ui? Thanks, Jiri
Unfortunately, the Swagger UI for both the kie-server and kie-remote REST interfaces did not make it into 6.2. For more info about Swagger, see: https://helloreverb.com/developers/swagger
Closing as not a bug. 1. This is a feature request 2. We are working on other documentation solutions.