https://github.com/xlorne/swaggerui
markdown形式的swagger-ui接口文档
https://github.com/xlorne/swaggerui
markdwon swaggerui
Last synced: 9 months ago
JSON representation
markdown形式的swagger-ui接口文档
- Host: GitHub
- URL: https://github.com/xlorne/swaggerui
- Owner: xlorne
- Created: 2018-09-18T02:24:07.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-19T04:55:57.000Z (over 7 years ago)
- Last Synced: 2025-03-03T04:44:16.723Z (about 1 year ago)
- Topics: markdwon, swaggerui
- Language: JavaScript
- Homepage:
- Size: 5.32 MB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# markdown-swagger-ui
> markdown形式的swagger-ui接口文档
## 使用说明
该框架是基于swagger-ui 2.8.0 界面扩展
* 将swagger-ui 2.8.0的jar用如下maven配置替换
```
com.codingapi.swagger
swagger-ui
2.8.0
```
* 在项目的resources下添加static/md文件夹下，然后添加接口文档的md文件
```
.
└── static
├── img
│ └── logo.png
└── md
├── index.md
└── index2.md
```
* markdown文档格式如下
```
# Demo项目演示文档
## 首页接口
接口描述，该接口是用于手机端登录接口。
### 首页接口2
我是接口说明2。
```
支持## ### 交替索引的目录
关于api标签说明:
mapping 对应项目中controller的mapping全路径
method 对应请求方式
编写文档的时候可以用markdown格式写清楚接口定义
* 接口文档访问路径
http://ip:port/md/xxx.md
例如：
http://127.0.01:8080/md/index.md
## 效果
## 关于Test(接口测试)
点击Test的时候会跳转到swagger2.8.0官网文档界面，然后会自动打开对应接口的调试界面。
## 示例项目
https://github.com/1991wangliang/demo-test
## QA
Q：当访问界面时遇到如下错误
```
Whitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback.
Wed Sep 19 20:15:01 CST 2018 There was an unexpected error (type=Internal Server Error, status=500). Exception parsing document: template="markdown", line 461 - column 43
```
A: 在项目的pom文件的properties下添加如下配置
```
3.0.9.RELEASE
2.0.4
```