openapi uml generation error

Question

openapi uml generation error

orion-belt opened this issue 2 years ago · comments

Hi @davidmoten
I tried to build uml for 5gc openapis. I built openapi-to-plantuml first.
Then I run inside 5gc open api folder -> https://github.com/jdegre/5GC_APIs.git. but I get below error.
Am I doing in correct way ?

5GC_APIs$ java -jar openapi-to-plantuml/target/openapi-to-plantuml-0.1.9-SNAPSHOT-jar-with-dependencies.jar  TS29531_Nnssf_NSSelection.yaml PNG openapi.png11
SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
SLF4J: Defaulting to no-operation (NOP) logger implementation
SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
Exception in thread "main" java.lang.RuntimeException: could not find ref=./TS29571_CommonData.yaml#/components/schemas/NfInstanceId
	at com.github.davidmoten.oas3.internal.Names.refToClassName(Names.java:94)
	at com.github.davidmoten.oas3.internal.Common.getUmlTypeName(Common.java:285)
	at com.github.davidmoten.oas3.internal.Common.getUmlTypeName(Common.java:279)
	at com.github.davidmoten.oas3.internal.Common.getUmlTypeName(Common.java:302)
	at com.github.davidmoten.oas3.internal.Common.getUmlTypeName(Common.java:279)
	at com.github.davidmoten.oas3.internal.Common.lambda$toModelClass$1(Common.java:120)
	at java.base/java.util.LinkedHashMap$LinkedEntrySet.forEach(LinkedHashMap.java:671)
	at com.github.davidmoten.oas3.internal.Common.toModelClass(Common.java:81)
	at com.github.davidmoten.oas3.internal.ComponentsHelper.lambda$toModel$0(ComponentsHelper.java:24)
	at java.base/java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:195)
	at java.base/java.util.Iterator.forEachRemaining(Iterator.java:133)
	at java.base/java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1801)
	at java.base/java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:484)
	at java.base/java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:474)
	at java.base/java.util.stream.ReduceOps$ReduceOp.evaluateSequential(ReduceOps.java:913)
	at java.base/java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234)
	at java.base/java.util.stream.ReferencePipeline.reduce(ReferencePipeline.java:553)
	at com.github.davidmoten.oas3.internal.ComponentsHelper.toModel(ComponentsHelper.java:26)
	at com.github.davidmoten.oas3.puml.Converter.openApiToPuml(Converter.java:62)
	at com.github.davidmoten.oas3.puml.Converter.openApiToPuml(Converter.java:55)
	at com.github.davidmoten.oas3.puml.Converter.openApiToPuml(Converter.java:41)
	at com.github.davidmoten.oas3.puml.Converter.openApiToPuml(Converter.java:46)
	at com.github.davidmoten.oas3.puml.ConverterMain.main(ConverterMain.java:42)
5GC_APIs$ 
5GC_APIs$ 
5GC_APIs$ ls | grep TS29571_CommonData.yaml
TS29571_CommonData.yaml

Dave Moten · Answer 1 · Tue Apr 05 2022 18:28:12 GMT+0800 (China Standard Time)

This happens because the library does not support external references (at the moment). The whole definition needs to be in one file. I'll have a think about it to see how much work is involved in supporting that.

Dave Moten · Answer 2 · Tue Apr 05 2022 18:41:14 GMT+0800 (China Standard Time)

I guess an obvious question is how would we want it to look? These are large definitions you are looking at. My first guess is if a.yml references b.yml then we would display all of a.yml and expand visually the referred bits of b.yml (and their references). What do you want to see?

Rohan · Answer 3 · Tue Apr 05 2022 19:28:18 GMT+0800 (China Standard Time)

My first guess is if a.yml references b.yml then we would display all of a.yml and expand visually the referred bits of b.yml (and their references).

Hi @davidmoten
Thanks a lot for your response. Yes you are right.
Normally there are common data types in same yaml or different referred yaml.
and I want to visualize their hierarchy.
I did this manual & very dirty UML. Like this perhaps.

Dave Moten · Answer 4 · Sat Apr 16 2022 18:46:18 GMT+0800 (China Standard Time)

I've made a PR so at least you don't get a failure when running the puml generation against a file with external refs. See #61 for your review if you like.

Dave Moten · Answer 5 · Sat Apr 16 2022 19:02:27 GMT+0800 (China Standard Time)

I've release 0.1.9 to Maven Central with this simple external ref handling from #61.

Dave Moten · Answer 6 · Wed Apr 27 2022 11:02:40 GMT+0800 (China Standard Time)

I see the swagger-parser library used internally supports resolution of external refs. Not enabled at the moment clearly but it looks like full support for external refs will be pretty easy.

Rohan · Answer 7 · Wed Apr 27 2022 20:05:53 GMT+0800 (China Standard Time)

Hi @davidmoten
Thanks for your information. I have re-built with your changes but I get same error as above.

Dave Moten · Answer 8 · Thu Apr 28 2022 07:35:08 GMT+0800 (China Standard Time)

really? Ok, I'll try it.

Dave Moten · Answer 9 · Thu Apr 28 2022 08:54:20 GMT+0800 (China Standard Time)

Works for me. Creates a dirty big SVG:

Dave Moten · Answer 10 · Thu Apr 28 2022 09:23:32 GMT+0800 (China Standard Time)

Just use 0.1.9

Dave Moten · Answer 11 · Thu Apr 28 2022 09:24:15 GMT+0800 (China Standard Time)

Works here too: https://openapi-to-puml.davidmoten.org/prod/site/index.html. Just paste the openapi defintiion in.

Rohan · Answer 12 · Thu Apr 28 2022 17:18:27 GMT+0800 (China Standard Time)

Many thanks @davidmoten
It is working for me now.