https://github.com/rstyro/markdown-doc
一个基于SpringBoot+Editor.md的 API接口文档
https://github.com/rstyro/markdown-doc
api doc markdown
Last synced: about 1 year ago
JSON representation
一个基于SpringBoot+Editor.md的 API接口文档
- Host: GitHub
- URL: https://github.com/rstyro/markdown-doc
- Owner: rstyro
- Created: 2018-07-15T14:26:33.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-06-20T23:17:16.000Z (almost 4 years ago)
- Last Synced: 2025-03-27T22:13:27.277Z (about 1 year ago)
- Topics: api, doc, markdown
- Language: Java
- Homepage:
- Size: 3.08 MB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MarkDown-Doc
### 看名字就知道，这个是一个MarkDown 语法的接口文档
### 使用方法：
+ 1、创建一个数据库并倒入sql脚本：doc.sql
+ 2、将Application.class 中的 `IS_AUTH` 改为`false`(意思就是不用登录也可以看文档，true -- 则需要登录才可观看文档)
+ 3、用户：admin，密码：admin
+ 4、新建接口的时候，都会默认生成一个模板，然后进行修改。生成模板的文件路径为：/resource/model.txt
+ 5、别忘了自行修改 `application.properties` 中连接数据库的用户及用户密码
## 示例图如下：
### 接口测试那里还有点小问题，就是接口会有跨域问题。如果后端有跨域设置，才能访问。比如在服务器的拦截器中加入以下代码：
```
this.response.addHeader("Access-Control-Allow-Origin", "*");//可设置成指定域名可访问
this.response.addHeader("Access-Control-Allow-Methods", "get, post, put, delete, options");
this.response.addHeader("Access-Control-Allow-Headers", "origin, content-type, accept");
this.response.addHeader("Access-Control-Allow-Credentials", "true");
```