Darshan Hiranandani : Automating API Design Diagrams from Swagger Specs

Hi Team,

I’m looking to create an API design diagram that visually represents the relationships between endpoints, as well as their requests and responses. I believe using Swagger (OpenAPI) specifications could help achieve this automatically.

Here’s what I’m aiming for:

• Visualize the relationships between different API endpoints.
• Show the requests and responses for each endpoint.
• Define how parameters and attributes relate across different endpoints.

Does anyone have experience or recommendations on how to automate this process using Swagger specs? Specifically:

1. Tools and Techniques: Are there tools or platforms that can generate API diagrams from Swagger specs?
2. Customizations: How can I specify relationships between parameters and endpoints within Swagger specs to be reflected in the diagram?
3. Best Practices: What are the best practices for setting up Swagger specs to ensure accurate and useful diagram generation?

Any insights or suggestions on achieving this would be greatly appreciated!

Thank you, 

Darshan Hiranandani