用阿里的通义千问2.5辅助，写了个接口json文件转markdown的小脚本

## 引言

我们平时开发一般都用`postman`来做简单开发，写好接口，放`postman`里一测就完事了，后续写文档是个超级痛苦的事情，一点都不想干

所以搞了个`postman`收藏导出成`json`文件，然后用`js`来做一些解析处理，生成一个`markdown`文档，这样看的也方便

## 效果

![生成结果（typora软件预览）](https://static.hw13.cn/usr/uploads/2024/07/1546746979.png)

![生成文件](https://static.hw13.cn/usr/uploads/2024/07/362650636.png)

## 脚本源码

此脚本因为是我在本地运行的，就基本上使用了模板字符串拼接，没有使用`document`对象来做

```javascript
const fs = require('fs');

// 读取Postman Collection JSON文件
fs.readFile('postman_collection.json', 'utf-8', (err, data) => {
  if (err) {
    console.error('Error reading file:', err);
    return;
  }

// 解析JSON数据
  const collection = JSON.parse(data);

// 创建Markdown文档
  let markdown = '';

function getCodeBox(obj, type = 'json') {
      return `\n\n\`\`\`${type}\n${JSON.stringify(obj, null, 2)}\n\`\`\`\n\n`
  }

// 递归遍历请求项和文件夹
  function traverseItems(items, depth = 1) {
    items.forEach(item => {
      if (item.item) {
        // console.log(depth+1, item.name);
        // 如果有子项，则递归处理子文件夹
        markdown += `\n${'#'.repeat(depth + 1)} ${item.name}\n\n`;
        traverseItems(item.item, depth + 1);
      } else {
        // 处理单个请求项
        let authInfo = '';
        if (item.auth) {
          authInfo = `**Authentication**\n\`${JSON.stringify(item.auth, null, 2)}\``;
        }

let variables = '';
        if (item.variable) {
          variables = `**Variables**\n\`${JSON.stringify(item.variable, null, 2)}\``;
        }

let prerequestScript = '';
        if (item.event && item.event.some(e => e.listen === 'prerequest')) {
          prerequestScript = `- **请求拦截**: ${getCodeBox(item.event.filter(e => e.listen === 'prerequest')[0].script.exec.join('\n'))}\n`;
        }

let testScript = '';
        if (item.event && item.event.some(e => e.listen === 'test')) {
            let testStr = item.event.filter(e => e.listen === 'test')[0].script.exec.join('\n')
            testScript = `- **响应拦截** \n\`\`\`js\n${testStr}\n\`\`\`\n`;
        }

// 接口名称
        markdown += `\n${'#'.repeat(depth + 1)} ${item.name}\n\n`;
        // 接口地址
        markdown += `- **接口地址:** ${item.request.url.raw}\n\n`;
        markdown += `- **请求类型:** ${item.request.method}\n\n`;
        markdown += `- **请求头部:** ${getCodeBox(item.request.header)}\n`;
        if (item.request.body) {
            markdown += `- **加密方式:** ${item.request.body.mode}\n`;
            markdown += `- **请求参数:** ${getCodeBox(item.request.body.urlencoded)}\n`;
        } else {
            markdown += `- **请求参数:** ${getCodeBox(item.request.body)}\n`;
        }

if (authInfo) markdown += `\n${authInfo}\n`
        if (authInfo) markdown += `\n${variables}\n`
        if (authInfo) markdown += `\n${prerequestScript}\n`
        if (authInfo) markdown += `\n${testScript}\n`
      }
    });
  }

// 开始递归遍历
  traverseItems(collection.item);

// 添加全局变量和环境
  if (collection.variable) {
    markdown += `\n## Global Variables\n ${getCodeBox(collection.variable)}`;
  }

if (collection.auth) {
    markdown += `
      \n## Global Authentication\n
      \`${JSON.stringify(collection.auth, null, 2)}\`
    `;
  }

// 写入Markdown文件
  fs.writeFile('api_docs.md', markdown, err => {
    if (err) {
      console.error('Error writing file:', err);
    } else {
      console.log('API documentation has been generated successfully.');
    }
  });
});
```

欢迎关注拓行公众号，分享各种技术博客文章

拓行——奋勇进取，开拓未来，砥砺前行

最后修改：2024 年 07 月 25 日

如果您对各种技术博客文章感兴趣，欢迎关注拓行公众号，分享各种专业技术知识~

用阿里的通义千问2.5辅助，写了个接口json文件转markdown的小脚本

黄炜 • 2024 年 07 月 25 日

用阿里的通义千问2.5辅助，写了个接口json文件转markdown的小脚本

typecho后台文章撰写的自定义字段默认收起

手把手教你在Linux下源码编译安装phpv8.3.0最新版

手把手教你在Linux下源码搭建MySQL关系型数据库v8.2.0最新社区版

Linux如何上传、下载传输文件或目录

手把手教你源码搭建Nginx服务器v1.25.3最新版（非root启动）

母上大人的饭-241110

【广州白云】龙井湖(安华汇店)

母上大人做的饭-241102

山东省-青岛市

使用Nginx在一台Linux服务器上部署多个站点域名

用阿里的通义千问2.5辅助，写了个接口json文件转markdown的小脚本