给接口添加描述

通过看到:

Postman给API添加描述

Intro to API documentation

得知,API的描述中,也支持Markdown的。

所以,可以很方便的添加有条理的接口描述,尤其是参数解释了:

Postman给Edit编辑

可以看到Descriptions support Markdown

Postman支持Markdown写描述

而对于要解释的参数,可以通过之前的Param -> Bulk Edit的内容:

Postman批量更新参数

拷贝过来,再继续去编辑:

Postman编辑Markdown描述内容

以及添加更多解释信息:

Postman添加更多的Markdown内容

点击Update后,即可保存。

发布后带Markdown描述的API的效果

去发布后:

Postman去Publish Docs

对应的效果:有道翻译

Postman发布后Markdown效果

Postman发布后Markdown中代码效果

results matching ""

    No results matching ""