Mermaid diagram in postman doc

Hi,

I was wondering if it was possible to use mermaid, markdown-like script language, to generate diagram and charts in an API documentation ?
Or if not with mermaid , is there any other way to import charts into the documentation : sequence or state diagrams for instance.
Thank you for your help,

1 Like

This would indeed be very interesting!

I was looking for the same thing. +1

One option is to export your diagrams to an image, host it in something like an s3 bucket, and use the markdown syntax to render an image

![Alt Text](link to image)

Hi @olga,

If you are familiar with Markdown, Postman supports GitHub flavoured Markdown, so you can create images using mermaid, host it online and then link to the image from Postman docs.

For more information, see these links:

Using images in docs
Include details in your doc

Also, check out Mermaid docs for hosting mermaid images online.

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.