{"id":18849358,"url":"https://github.com/rstyro/markdown-doc","last_synced_at":"2025-04-14T08:42:20.341Z","repository":{"id":41046592,"uuid":"141033874","full_name":"rstyro/MarkDown-Doc","owner":"rstyro","description":"一个基于SpringBoot+Editor.md的 API接口文档","archived":false,"fork":false,"pushed_at":"2022-06-20T23:17:16.000Z","size":3229,"stargazers_count":4,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-27T22:13:27.277Z","etag":null,"topics":["api","doc","markdown"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rstyro.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-07-15T14:26:33.000Z","updated_at":"2023-01-02T16:05:14.000Z","dependencies_parsed_at":"2022-09-20T21:15:24.739Z","dependency_job_id":null,"html_url":"https://github.com/rstyro/MarkDown-Doc","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstyro%2FMarkDown-Doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstyro%2FMarkDown-Doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstyro%2FMarkDown-Doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rstyro%2FMarkDown-Doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rstyro","download_url":"https://codeload.github.com/rstyro/MarkDown-Doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248849440,"owners_count":21171577,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","doc","markdown"],"created_at":"2024-11-08T03:19:24.359Z","updated_at":"2025-04-14T08:42:20.320Z","avatar_url":"https://github.com/rstyro.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MarkDown-Doc\n### 看名字就知道，这个是一个MarkDown 语法的接口文档\n### 使用方法：\n+ 1、创建一个数据库并倒入sql脚本：doc.sql\n+ 2、将Application.class 中的 `IS_AUTH` 改为`false`(意思就是不用登录也可以看文档，true -- 则需要登录才可观看文档)\n+ 3、用户：admin，密码：admin\n+ 4、新建接口的时候，都会默认生成一个模板，然后进行修改。生成模板的文件路径为：/resource/model.txt\n+ 5、别忘了自行修改 `application.properties` 中连接数据库的用户及用户密码\n\n## 示例图如下：\n![https://github.com/rstyro/MarkDown-Doc/blob/master/img/api.png](https://github.com/rstyro/MarkDown-Doc/blob/master/img/api.png)\n![https://github.com/rstyro/MarkDown-Doc/blob/master/img/apitest.png](https://github.com/rstyro/MarkDown-Doc/blob/master/img/apitest.png)\n\n### 接口测试那里还有点小问题，就是接口会有跨域问题。如果后端有跨域设置，才能访问。比如在服务器的拦截器中加入以下代码：\n```\nthis.response.addHeader(\"Access-Control-Allow-Origin\", \"*\");//可设置成指定域名可访问\nthis.response.addHeader(\"Access-Control-Allow-Methods\", \"get, post, put, delete, options\");\nthis.response.addHeader(\"Access-Control-Allow-Headers\", \"origin, content-type, accept\");\nthis.response.addHeader(\"Access-Control-Allow-Credentials\", \"true\");\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frstyro%2Fmarkdown-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frstyro%2Fmarkdown-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frstyro%2Fmarkdown-doc/lists"}