Postman接口测试(四):接口描述与自动生成文档

原文链接
参考链接

接口描述与自动生成文档

API 的描述中,也支持 Markdown,官方的接口说明文档:Intro to API documentation

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

这里写图片描述

描述支持 markdown 语法

这里写图片描述

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

这里写图片描述

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

这里写图片描述

以及添加更多解释信息:

这里写图片描述

点击 Update 后,即可保存。

发布接口并生成 markdown 的描述文件

去发布后:

这里写图片描述

对应的效果:有道翻译

这里写图片描述

这里写图片描述

发布了48 篇原创文章 · 获赞 3 · 访问量 4209

猜你喜欢

转载自blog.csdn.net/NoamaNelson/article/details/103919959
今日推荐