Hacker News Reader

By the sounds of it, you'd use this as an overview and use something like Swagger for the actual details of each endpoint.

(For that matter, if you output the diagram in a format that supports hyperlinks like SVG or PDF, you could link from the diagram directly into Swagger.)

View on HN

That's exactly the point of this diagram - make audience familiar with the API's domain before throwing them into useful detail of specs like Swagger.

You brought another very good point about being able to hyperlink directly into Swagger, something we have been talking about a lot recently. Unfortunately, we have not come across a tool that does this satisfactorily.

Reply on news.ycombinator.com