# postman2word

**Repository Path**: xia_yong_chao/postman2word

## Basic Information

- **Project Name**: postman2word
- **Description**: postman转换为word，直接生成接口文档。
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: https://gitee.com/xia_yong_chao/postman2word
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 0
- **Created**: 2022-08-02
- **Last Updated**: 2023-12-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: POSTMAN, 接口文档, API

## README

<!--
 * @Author: xiayongchao
 * @Date: 2022-10-11 10:04:03
 * @LastEditors: xiayongchao
 * @LastEditTime: 2022-10-27 16:53:01
 * @FilePath: \postman2word\README.md
 * @Description: 
-->

# postman2word

## 简介

使用postman测试接口，将导出的json文件转化为word文档，直接生成接口文档，就不用自己再写啦。

对你有帮助的话就点个star吧，谢谢 :laughing:

## 使用方法

##### 1. 在postman里创建接口。
![step1](img/step1.jpg)

##### 2. 保存请求结果，如果不保存，在接口文档中，请求结果一栏中没有数据，如果你保存了多个请求结果，默认取第一个。
![step2](img/step2.jpg)

##### 3. 导出接口成json文件。
![step3](img/step3.jpg)

##### 4. 修改配置文件，运行程序即可。
```yml
# Collections json文件路径（必须）
collectionFilePath: D:\postman2word\postman2word.postman_collection.json
# environment json文件路径（非必须）
environmentFilePath: D:\postman2word\postman2word.postman_environment.json
# word文件保存路径（必须，会自动生成文件名）
wordSavePath: D:\postman2word\
# 表格边框样式，STBorder.Enum.forString("single")
tableBorder: single
# 是否开启标签匹配
isTagMatch: true
# 添加标签在word文件中的标题
addName: 新增
# 更新标签在word文件中的标题
updateName: 更新
# 删除标签在word文件中的标题
deleteName: 不建议使用
# 标签使用：在postman接口名称后面加上标签即可
# 添加标签
addTags: [【add】, 【new】, 【新增】, 【新添加】]
# 更新标签
updateTags: [【update】, 【edit】, 【更新】]
# 删除标签
deleteTags: [【delete】, 【deprecated】, 【已删除】, 【已弃用】, 【不建议使用】]


```