Postman 是一款常用的 API 开发工具，但是在开发过程中可能需要将 API 接口文档分享给其他人查看，这时候可以使用 postman-doc-generator 这个 npm 包来生成接口文档。
postman-doc-generator 是一个基于 Postman 集合（Collection）和 Markdown 语言的工具，可以将 Postman 集合中的请求和响应信息自动转换成 Markdown 格式的文档，并带有请求示例和响应示例。
安装
前置条件：已安装 Node.js
在命令行中输入以下命令进行安装：
npm install -g postman-doc-generator
使用
步骤一：导出 Postman 集合
在 Postman 工具中，选择要导出的集合，点击右键选择「Export」，选择「Collection v2.1」格式，保存为 JSON 文件。
步骤二：生成文档
在命令行中输入以下命令生成文档：
postman-doc-generator -i collection.json -o output.md
其中，-i 指定输入文件名，-o 指定输出文件名。
步骤三：查看文档
打开生成的 Markdown 文件 output.md，即可查看生成的接口文档。
示例代码
以下是一个简单的 Postman 集合和使用 postman-doc-generator 生成文档的示例代码：
Postman 集合
先来看一下示例使用的 Postman 集合：
-- -------------------- ---- -------
-
------- -
-------------- ---------------------------------------
------- --- -----
--------- ----------------------------------------------------------------------
--
------- -
-
------- ---- ------
---------- -
------ -
------ -----------------------------------
----------- --------
------- -
------
----------
-----
--
------- -
-------
-----
-
--
--------- ------
--------- -
-
------ ----------------
-------- ------- -------------------------------------
-
-
--
----------- --
-
-
-postman-doc-generator
接下来看一下使用 postman-doc-generator 生成文档的代码：
postman-doc-generator -i myapi.json -o myapi.md
其中，myapi.json 是上面的 Postman 集合文件名，myapi.md 是生成的 Markdown 文件名。
生成的 Markdown 文档
最后，看一下生成的 Markdown 文档：
-- -------------------- ---- ------- - -- --- -- --- ---- --- ---- ------- ---- --------------------------------- --- ------- ------- - ------ - ----- - - ------ - ----- - - ------------- - ------ ------------------------------------ - --- -------- -----
通过这个示例可以看出，postman-doc-generator 生成的 Markdown 文档非常清晰明了，不仅包含了请求和响应信息，还可以带有请求示例和响应示例。这让我们在开发过程中可以更方便地分享和查看接口文档，提高了效率和协作能力。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6006734a890c4f727758374f