# swagger-markdown-ui

**Repository Path**: constStar/swagger-markdown-ui

## Basic Information

- **Project Name**: swagger-markdown-ui
- **Description**: 将Swagger V3 文档转换为离线的 Markdown 格式的文档
- **Primary Language**: JavaScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2021-09-22
- **Last Updated**: 2023-07-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 强化版 swagger-markdown-ui



## 简介

将Swagger V3 文档转换为离线的 Markdown 格式的文档




## 特点

- 支持swagger V3
- 通过URL获取接口
- 格式化文档结构
- 完整汉化
- 提取通用响应内容
- 更完整的响应内容




## 在线使用
[swagger-markdown-ui](http://swagger-markdown-ui.conststar.cn)




## 实例
[example.md](example.md)




## 快速使用

#### 初始化项目
```
npm install
```

#### 编译并运行
```
npm run serve
```

#### 编译生成
```
npm run build
```

#### 运行测试
```
npm run test
```

#### Lints and fixes files
```
npm run lint
```



## 感谢

- 感谢 [shaun-chiang/swagger-markdown-ui](https://github.com/shaun-chiang/swagger-markdown-ui) 提供原始代码