# postmanToWord

**Repository Path**: zhexiao/postman-to-word

## Basic Information

- **Project Name**: postmanToWord
- **Description**: Postman导出Collection v2.1类型的JSON文件转为WORD标准接口文档。WORD库基于builder模式编写，扩展性很强。
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 22
- **Forks**: 17
- **Created**: 2020-09-15
- **Last Updated**: 2024-07-30

## Categories & Tags

**Categories**: json-tools

**Tags**: None

## README

# postmanToWord
很懒，不喜欢写接口文档。现在开发用的是postman调接口，所以就开发这个工具方便大家快速的把postman导出的json转成标准的接口文档。  :laughing:  :laughing: 

[![Build Status](https://travis-ci.org/zhexiao/postmanToWord.svg?branch=master)](https://travis-ci.org/zhexiao/postmanToWord)
[![codecov](https://codecov.io/gh/zhexiao/postmanToWord/branch/master/graph/badge.svg)](https://codecov.io/gh/zhexiao/postmanToWord)
![java](https://img.shields.io/badge/java-1.8.0_251-blue)

## postman
Postman导出Collection v2.1类型的JSON文件转为WORD标准接口文档

### 操作流程
1. postman请求接口并保存返回结果为一个example

![Image text](./guide/postman/1.png)

2. 为example命令，一般一个成功的返回和一个失败的返回即可

![Image text](./guide/postman/2.png)

3. 导出这个接口所属的Collection

![Image text](./guide/postman/3.png)

4. 导出v2.1版本

![Image text](./guide/postman/4.png)

5. 运行这个项目，并调用convert接口把json转换成word接口文档

![Image text](./guide/postman/5.png)

6. 调用convert接口会返回一个对象，核心请求数据在visitPath

![Image text](./guide/postman/6.png)

7. 打开visitPath链接地址，会下载一个接口文档word

![Image text](./guide/postman/7.png)

## 核心自定义配置
application.yml
```yaml
app:
  fileDest: "F:/workspace/postmanToWord/uploads"
  filePathRoute: "/uploads/" # 上传的访问地址
  fileVisitHost: "http://localhost:8888" # 上传的文件地址访问主机名
```