feat: Add OpenAPI UI. (based on @mingfang fork)

Author: ludomikula

server/api-service/lowcoder-domain/src/main/java/org/lowcoder/domain/query/service/QueryExecutionService.java

@@ -47,7 +47,7 @@ public Mono<QueryExecutionResult> executeQuery(Datasource datasource, Map<String
 
         return Mono.defer(() -> {
                     if (datasourceMetaInfoService.isJsDatasourcePlugin(datasource.getType())) {
-                        return executeByNodeJs(datasource, queryConfig, requestParams);
+                        return executeByNodeJs(datasource, queryConfig, requestParams, queryVisitorContext);
                     }
                     return executeLocally(datasource, queryConfig, requestParams, queryVisitorContext);
                 })
@@ -77,11 +77,19 @@ private Mono<QueryExecutionResult> executeLocally(Datasource datasource, Map<Str
                 });
     }
 
-    private Mono<QueryExecutionResult> executeByNodeJs(Datasource datasource, Map<String, Object> queryConfig, Map<String, Object> requestParams) {
+    private Mono<QueryExecutionResult> executeByNodeJs(Datasource datasource, Map<String, Object> queryConfig, Map<String, Object> requestParams, QueryVisitorContext queryVisitorContext) {
         List<Map<String, Object>> context = requestParams.entrySet()
                 .stream()
                 .map(entry -> Map.of("key", entry.getKey(), "value", entry.getValue()))
                 .collect(Collectors.toList());
+
+        //forward cookies to js datasource
+        List<Map<String, Object>> cookies = queryVisitorContext.getCookies().entrySet()
+                .stream()
+                .map(entry -> Map.of("key", entry.getKey(), "value", entry.getValue()))
+                .collect(Collectors.toList());
+        context.addAll(cookies);
+
         return datasourcePluginClient.executeQuery(datasource.getType(), queryConfig, context, datasource.getDetailConfig());
     }
 }

server/api-service/lowcoder-server/pom.xml

@@ -54,6 +54,11 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-webflux</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-webflux-ui</artifactId>
+            <version>1.7.0</version>
+        </dependency>        
         <dependency>
             <groupId>io.projectreactor.tools</groupId>
             <artifactId>blockhound</artifactId>

server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/OpenAPIDocsConfiguration.java

@@ -0,0 +1,38 @@
+package org.lowcoder.api;
+
+import io.swagger.v3.oas.models.Components;
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+import io.swagger.v3.oas.models.security.SecurityRequirement;
+import io.swagger.v3.oas.models.security.SecurityScheme;
+import io.swagger.v3.oas.models.servers.Server;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.lowcoder.sdk.config.CommonConfig;
+import org.springframework.beans.factory.annotation.Autowired;
+
+@Configuration
+public class OpenAPIDocsConfiguration {
+    @Autowired
+    private CommonConfig commonConfig;
+
+    @Bean
+    public OpenAPI customizeOpenAPI() {
+        final String securitySchemeName = commonConfig.getCookieName();
+        return new OpenAPI()
+                .info(new Info()
+                        .title("Lowcoder API")
+                        .version("1.0"))
+                .addServersItem(new Server()
+                        .url("/"))
+                .addSecurityItem(new SecurityRequirement()
+                        .addList(securitySchemeName)).components(new Components()
+                        .addSecuritySchemes(
+                                securitySchemeName,
+                                new SecurityScheme()
+                                        .name(securitySchemeName)
+                                        .type(SecurityScheme.Type.APIKEY)
+                                        .in(SecurityScheme.In.COOKIE)
+                        ));
+    }
+}

server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/ServerApplication.java

@@ -11,6 +11,7 @@
 import org.springframework.context.annotation.ComponentScan;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
 import lombok.extern.slf4j.Slf4j;
 import reactor.blockhound.BlockHound;
 import reactor.core.publisher.Hooks;
@@ -22,6 +23,7 @@
 @ComponentScan(basePackages = "org.lowcoder.api.framework.configuration")
 @EnableScheduling
 @EnableConfigurationProperties
+@OpenAPIDefinition
 public class ServerApplication {
 
     @Autowired

server/api-service/lowcoder-server/src/main/java/org/lowcoder/api/framework/security/SecurityConfig.java

@@ -126,7 +126,8 @@ public SecurityWebFilterChain securityWebFilterChain(ServerHttpSecurity http) {
                         ServerWebExchangeMatchers.pathMatchers(HttpMethod.POST, NewUrl.QUERY_URL + "/execute"),
                         ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.MATERIAL_URL + "/**"),
                         ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.ORGANIZATION_URL + "/*/datasourceTypes"), // datasource types
-                        ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.DATASOURCE_URL + "/jsDatasourcePlugins")
+                        ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, NewUrl.DATASOURCE_URL + "/jsDatasourcePlugins"),
+                        ServerWebExchangeMatchers.pathMatchers(HttpMethod.GET, "/api/docs/**")
                 )
                 .permitAll()
                 .pathMatchers("/api/**")

server/api-service/lowcoder-server/src/main/resources/application-lowcoder.yml

@@ -48,3 +48,10 @@ common:
 material:
   mongodb-grid-fs:
     bucket-name: material
+
+springdoc:
+  api-docs:
+    path: /api/docs/api-docs
+  swagger-ui:
+    path: /api/docs/swagger-ui
+  paths-to-exclude: /api/v1/**

server/api-service/lowcoder-server/src/main/resources/selfhost/ce/application.yml

@@ -46,3 +46,10 @@ common:
 material:
   mongodb-grid-fs:
     bucket-name: material
+
+springdoc:
+  api-docs:
+    path: /api/docs/api-docs
+  swagger-ui:
+    path: /api/docs/swagger-ui
+  paths-to-exclude: /api/v1/**

server/node-service/src/plugins/openApi/index.ts

@@ -25,7 +25,7 @@ const dataSourceConfig = {
       label: "Spec URL",
       key: "url",
       type: "textInput",
-      updatable: false,
+      updatable: true,
       rules: [
         {
           required: true,
@@ -146,18 +146,11 @@ const openApiPlugin: DataSourcePlugin<ActionDataType, DataSourceDataType> = {
   dataSourceConfig: {
     ...dataSourceConfig,
     extra: async (dataSourceConfig) => {
-      const { url, extra } = dataSourceConfig;
-      let spec: string = extra?.spec;
-      let specObj: OpenAPI.Document;
-      if (!spec) {
-        // retrieve spec from remote only once
-        const { spec: remoteSpec } = await retrieveSpec(url);
-        specObj = remoteSpec;
-        spec = JSON.stringify(remoteSpec);
-      } else {
-        specObj = safeJsonParse(spec);
-      }
+      // called whenever datasource config opens or changes
+      const { url} = dataSourceConfig;
+      const { spec: specObj} = await retrieveSpec(url);
       const extraParams = await authParamsConfig(specObj);
+      const spec = JSON.stringify(specObj);
       return {
         data: {
           spec,

server/node-service/src/services/plugin.ts

@@ -211,6 +211,14 @@ export async function runPluginQuery(
   const plugin = getPlugin(pluginName, pluginContext);
   const queryConfig = await getQueryConfig(plugin, dataSourceConfig);
   const action = await evalToValue(queryConfig, dsl, context, dataSourceConfig);
+
+  //forward cookies
+  context.forEach(({ key, value }) => {
+    if (key in dataSourceConfig.dynamicParamsConfig) {
+      const valueKey = `${key}.value`;
+      dataSourceConfig.dynamicParamsConfig[valueKey] = value[0].value
+    }
+  })
   const result = await plugin.run(action, dataSourceConfig, pluginContext);
 
   return {