Export relationships as a list

[jumangee]

Description

After completing the architecture model, there is a need to generate a list of APIs, i.e. export relationship endpoints with implementation technology (e.g. "REST" or "KAFKA") as list

At the input - model, parameters: types of entities whose relationships to unload (system, container, component), side of the relationship (input/output/all), technology ("REST", "KAFKA", etc)

The output is a table (for example CSV)
Source,Destination,title
system1,system2,data transfer api

Priority

Medium

Resolution

I have no budget and there's no rush, please add this feature for free

More information

There is no export of model data to lists at all

[simonbrowndotje]

It's not something that I want to add to the export library, but it's straightforward to build a Java program yourself that does this with a dependency on the structurizr-client library.

[jumangee]

I'm not a java developer, so it's too hard for me. Why should the export be to diagrams only? ok, did I request a complicated export? then simply - export all relationships as a table

[simonbrowndotje]

If you're using the DSL, you could do this with a script; for example (you would need to properly escape commas, etc):

    !script groovy {
        File file = new File("/usr/local/structurizr/relationships.txt")
        file.write("source,destination,description\n")
        workspace.model.relationships.findAll( it -> file.append (it.source.name + "," + it.destination.name + "," + it.description + "\n") )
    }

[jumangee]

Thank you very much! It's great!