如何为邮递员文档设置锚点?

时间:2018-07-13 09:18:23

标签: postman

我制作了api的文档,如何在邮递员中使用markdown进行交叉引用(命名为anchor)?

有类似的选择吗?

Take me to <a href="#api"> rest api </a> ... <a name="api"> this is rest api </a>

1 个答案:

答案 0 :(得分:0)

您可以在集合/文件夹/请求描述中创建一个id为“ api”的元素,然后将其链接到另一个地方,例如[rest api](#api)

如果要链接文件夹或请求,则应该从文档本身获取ID,然后使用与以前相同的Markdown以及相应的ID。

注意:请考虑到邮递员文档(目前)不提供一种为文件夹或请求指定自定义ID的方法,因此在尝试这样做时,最好的办法是在说明顶部创建一个ID为id的元素,然后链接到该新元素。它将滚动到标题 下的一个点,这可能会导致较差的用户体验。