Add support for generating Structurizr legend.

Resolves #1686.
yuzutech · Feb 9, 2024 · ab1e608 · ab1e608
1 parent 29e9fca
commit ab1e608
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/docs/modules/setup/pages/diagram-options.adoc b/docs/modules/setup/pages/diagram-options.adoc
@@ -200,6 +200,10 @@ empty string ("")
 |_string_
 |Key of the view (if the workspace contains more than one view)
 
+|get-legend
+|_flag_
+|Return the view's legend rather than the view itself
+
 |===
 
 == Svgbob

diff --git a/server/src/main/java/io/kroki/server/service/Structurizr.java b/server/src/main/java/io/kroki/server/service/Structurizr.java
@@ -132,7 +132,16 @@ static byte[] convert(String source, FileFormat fileFormat, PlantumlCommand plan
       } else {
         throw new BadRequestException("View type is not supported: " + selectedView.getClass().getSimpleName() + ", must be a DynamicView, DeploymentView, ComponentView, ContainerView, SystemContextView or SystemLandscapeView.");
       }
-      return plantumlCommand.convert(diagram.getDefinition(), fileFormat, new JsonObject());
+
+      String diagramPlantUML;
+      String includeLegend = options.getString("get-legend");
+      if (includeLegend != null) {
+        diagramPlantUML = diagram.getLegend().getDefinition();
+      } else {
+        diagramPlantUML = diagram.getDefinition();
+      }
+
+      return plantumlCommand.convert(diagramPlantUML, fileFormat, new JsonObject());
     } catch (StructurizrDslParserException e) {
       String cause = e.getMessage();
       final String message;