返回介绍

接口描述与自动生成文档

发布于 2024-06-20 01:07:58 字数 1665 浏览 0 评论 0 收藏 0

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

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

Postman 给 Edit 编辑

描述支持 markdown 语法

Postman 支持 Markdown 写描述

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

Postman 批量更新参数

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

Postman 编辑 Markdown 描述内容

以及添加更多解释信息:

Postman 添加更多的 Markdown 内容

点击 Update 后,即可保存。

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

去发布后:

Postman 去 Publish Docs

对应的效果: 有道翻译

Postman 发布后 Markdown 效果

Postman 发布后 Markdown 中代码效果

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文