# postman2md

**Repository Path**: lfy2008/postman2md

## Basic Information

- **Project Name**: postman2md
- **Description**: postman导出的JSON文件转为markdown文件
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-08-13
- **Last Updated**: 2021-10-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# postman2md

#### 介绍
postman导出的JSON文件转为markdown文件

#### 软件架构
采用SpringBoot+Spring Shell编写，通过Freemaker渲染markdown文件并且导出。


#### 安装教程

1. 克隆项目编译后运行

#### 使用说明

1. 运行 java -jar postman2md-{version}.jar
2. 输入help可查看支持的命令
```
//启动后
shell:>help
AVAILABLE COMMANDS

Built-In Commands
        clear: Clear the shell screen.
        exit, quit: Exit the shell.
        help: Display help about available commands.
        script: Read and execute commands from a file.
        stacktrace: Display the full stacktrace of the last error.

Shell Start
        export-md: 导出markdown文件。例如:export-md c://api.json
```

3. 输入postman的json文件路径，可生成markdown文件。
```
//执行：
export-md G:\\api.json
```
#### 参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request


#### 后续开发
1. 支持多种分隔的markdown格式
2. 优化命令行交互提示