Merge pull request #43950 from phillip-kruger/endpoints-post-enhancement

Dev UI: Change the endpoints to navigate to Swagger UI if included

extensions/vertx-http/deployment/src/main/java/io/quarkus/devui/deployment/menu/EndpointsProcessor.java

@@ -1,7 +1,10 @@
 package io.quarkus.devui.deployment.menu;
 
+import io.quarkus.deployment.Capabilities;
+import io.quarkus.deployment.Capability;
 import io.quarkus.deployment.IsDevelopment;
 import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.ConfigurationBuildItem;
 import io.quarkus.devui.deployment.InternalPageBuildItem;
 import io.quarkus.devui.spi.JsonRPCProvidersBuildItem;
 import io.quarkus.devui.spi.page.Page;
@@ -16,13 +19,24 @@ public class EndpointsProcessor {
     private static final String DEVUI = "dev-ui";
 
     @BuildStep(onlyIf = IsDevelopment.class)
-    InternalPageBuildItem createEndpointsPage(NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem) {
+    InternalPageBuildItem createEndpointsPage(Capabilities capabilities, ConfigurationBuildItem configurationBuildItem,
+            NonApplicationRootPathBuildItem nonApplicationRootPathBuildItem) {
+
+        final boolean swaggerIsAvailable = capabilities.isPresent(Capability.SMALLRYE_OPENAPI);
+        final String swaggerUiPath;
+        if (swaggerIsAvailable) {
+            swaggerUiPath = nonApplicationRootPathBuildItem.resolvePath(
+                    getProperty(configurationBuildItem, "quarkus.swagger-ui.path"));
+        } else {
+            swaggerUiPath = "";
+        }
 
         String basepath = nonApplicationRootPathBuildItem.resolvePath(DEVUI);
 
         InternalPageBuildItem endpointsPage = new InternalPageBuildItem("Endpoints", 25);
 
         endpointsPage.addBuildTimeData("basepath", basepath);
+        endpointsPage.addBuildTimeData("swaggerUiPath", swaggerUiPath);
 
         // Page
         endpointsPage.addPage(Page.webComponentPageBuilder()
@@ -44,4 +58,31 @@ InternalPageBuildItem createEndpointsPage(NonApplicationRootPathBuildItem nonApp
     JsonRPCProvidersBuildItem createJsonRPCService() {
         return new JsonRPCProvidersBuildItem(NAMESPACE, ResourceNotFoundData.class);
     }
+
+    private static String getProperty(ConfigurationBuildItem configurationBuildItem,
+            String propertyKey) {
+
+        String propertyValue = configurationBuildItem
+                .getReadResult()
+                .getAllBuildTimeValues()
+                .get(propertyKey);
+
+        if (propertyValue == null) {
+            propertyValue = configurationBuildItem
+                    .getReadResult()
+                    .getBuildTimeRunTimeValues()
+                    .get(propertyKey);
+        } else {
+            return propertyValue;
+        }
+
+        if (propertyValue == null) {
+            propertyValue = configurationBuildItem
+                    .getReadResult()
+                    .getRunTimeDefaultValues()
+                    .get(propertyKey);
+        }
+
+        return propertyValue;
+    }
 }

extensions/vertx-http/dev-ui-resources/src/main/resources/dev-ui/qwc/qwc-endpoints.js

@@ -4,6 +4,7 @@ import '@vaadin/grid';
 import { columnBodyRenderer } from '@vaadin/grid/lit.js';
 import '@vaadin/grid/vaadin-grid-sort-column.js';
 import { JsonRpc } from 'jsonrpc';
+import { swaggerUiPath } from 'devui-data';
 
 /**
  * This component show all available endpoints
@@ -37,12 +38,14 @@ export class QwcEndpoints extends LitElement {
     `;
 
     static properties = {
+        filter: {type: String},
         _info: {state: true}
     }
 
     constructor() {
         super();
         this._info = null;
+        this.filter = null;
     }
 
     connectedCallback() {
@@ -56,7 +59,9 @@ export class QwcEndpoints extends LitElement {
         if (this._info) {
             const typeTemplates = [];
             for (const [type, list] of Object.entries(this._info)) {
-                typeTemplates.push(html`${this._renderType(type,list)}`);
+                if(!this.filter || this.filter === type){
+                    typeTemplates.push(html`${this._renderType(type,list)}`);
+                }
             }
             return html`${typeTemplates}`;
         }else{
@@ -86,8 +91,12 @@ export class QwcEndpoints extends LitElement {
     }
 
     _uriRenderer(endpoint) {
-        if (endpoint.uri) {
+        if (endpoint.uri && endpoint.description && endpoint.description.startsWith("GET")) {
             return html`<a href="${endpoint.uri}" target="_blank">${endpoint.uri}</a>`;
+        }else if(swaggerUiPath!==""){
+            return html`<a href="${swaggerUiPath}" title="Test this Swagger UI" target="_blank">${endpoint.uri}</a>`;
+        }else{
+            return html`<span>${endpoint.uri}</span>`;
         }
     }