Adds support for generating Mermaid diagrams from APIs #1113
Conversation
darrelmiller
requested review from
irvinesunday,
peombwa,
zengin,
baywet,
millicentachieng and
MaggieKimani1
as code owners
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| catch (Exception ex) | ||
| { | ||
| #if DEBUG | ||
| logger.LogCritical(ex, ex.Message); | ||
| throw; // so debug tools go straight to the source of the exception when attached | ||
| #else | ||
| logger.LogCritical( ex.Message); | ||
| return 1; | ||
| #endif | ||
| } |
Check notice
Code scanning / CodeQL
Generic catch clause
| } | ||
| } | ||
|
|
||
| private static void WriteTreeDocument(string openapi, OpenApiDocument document, StreamWriter writer) |
Check notice
Code scanning / CodeQL
Generic catch clause
|
@baywet You tricked me with that .Order() method. It doesn't exist. At least my version of .NET doesn't know about it. I put the .OrderBy( o=>o) back. |
@darrelmiller ah right! it's an addition of .net 7, sorry about that, I'm in the future. |
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
Co-authored-by: Vincent Biret <vibiret@microsoft.com>
|
OMG. I rebased successfully for the first time ever. |
|
@baywet The git CLI, yes. I was lucky because there were no merge conflicts. |
|
Code coverage metric achieved. :-) /cc @MaggieKimani1 @baywet |
|
good job on the coverage. I encourage you to check the code smells to wrap this up (+ the comment I left) https://sonarcloud.io/project/issues?id=microsoft_OpenAPI.NET&pullRequest=1113&resolved=false&types=CODE_SMELL |
|
Kudos, SonarCloud Quality Gate passed! |
Added a show command to the hidi command line and also added a WriteMermaid function to the OpenApiUriTreeNode class.
Examples of the output are here https://github.com/darrelmiller/openapi-collection/tree/main/ApiDiagrams
The show command wraps the mermaid in a markdown file with a legend to explain the coloring of the nodes. Each node is styled with a color that maps to the set of HTTP methods that are supported. This mapping is defined by the MermaidColorScheme dictionary on OpenApiUriTreeNode. That dictionary can be customized to change the colors or add new combinations of HTTP methods.
GitHub markdown does not render the HTML legend that the show command emits. However, the VS code markdown preview does.
This closes #820