vikalejo's avatar
vikalejo
Visitor
5 months ago
Status:
New Idea

API diagram design automatically

Hi, 

I am looking to build a API design diagram where I can see the endpoints relations, requests, response visually. 

With Swagger spec, I think it could be posible to implement it automatically. 

Defining a way to specify what parameter is a related attribute to other endpoints. 

With that in place, building a diagram automatically from the specs, would be feasible. 

That’s it make sense?

Thanks you

  • julioherrera's avatar
    julioherrera
    Occasional Visitor

    Yes, you can build an API design diagram showing endpoint relations, requests, and responses using Swagger (OpenAPI) specifications. By defining related attributes in the spec, you can use tools like Swagger UI or Swagger Editor for visualizing API interactions. For more advanced visualization, tools like SwaggerHub, Redocly, or Docusaurus can automatically generate interactive diagrams from the specs. Custom scripts can also parse the OpenAPI spec and create tailored diagrams using libraries like D3.js.