{"id":16526592,"url":"https://github.com/xlorne/swaggerui","last_synced_at":"2025-08-25T19:04:35.819Z","repository":{"id":144565373,"uuid":"149216588","full_name":"xlorne/swaggerui","owner":"xlorne","description":"markdown形式的swagger-ui接口文档","archived":false,"fork":false,"pushed_at":"2018-10-19T04:55:57.000Z","size":5574,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-03T04:44:16.723Z","etag":null,"topics":["markdwon","swaggerui"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/xlorne.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-09-18T02:24:07.000Z","updated_at":"2018-10-19T04:55:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"30d82ab5-e7c6-4db6-ac94-ea1c6529e232","html_url":"https://github.com/xlorne/swaggerui","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/xlorne/swaggerui","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlorne%2Fswaggerui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlorne%2Fswaggerui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlorne%2Fswaggerui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlorne%2Fswaggerui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xlorne","download_url":"https://codeload.github.com/xlorne/swaggerui/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xlorne%2Fswaggerui/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272116857,"owners_count":24876268,"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","status":"online","status_checked_at":"2025-08-25T02:00:12.092Z","response_time":1107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["markdwon","swaggerui"],"created_at":"2024-10-11T17:29:13.998Z","updated_at":"2025-08-25T19:04:35.791Z","avatar_url":"https://github.com/xlorne.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# markdown-swagger-ui\n\n\n\u003e markdown形式的swagger-ui接口文档\n\n\n## 使用说明\n\n 该框架是基于swagger-ui 2.8.0 界面扩展\n\n* 将swagger-ui 2.8.0的jar用如下maven配置替换\n\n``` \n \u003cdependency\u003e\n     \u003cgroupId\u003ecom.codingapi.swagger\u003c/groupId\u003e\n     \u003cartifactId\u003eswagger-ui\u003c/artifactId\u003e\n     \u003cversion\u003e2.8.0\u003c/version\u003e\n \u003c/dependency\u003e\n \n```\n\n* 在项目的resources下添加static/md文件夹下，然后添加接口文档的md文件\n\n```\n.\n└── static\n    ├── img\n    │   └── logo.png\n    └── md\n        ├── index.md\n        └── index2.md\n\n```\n\n\n* markdown文档格式如下\n\n```\n\n# Demo项目演示文档\n\n## 首页接口\n\n接口描述，该接口是用于手机端登录接口。\n\n\u003capi mapping=\"/demo/index\" method=\"post\"\u003e\u003c/api\u003e\n\n\n### 首页接口2\n\n我是接口说明2。 \n\n\u003capi mapping=\"/demo/index2\" method=\"post\"\u003e\u003c/api\u003e\n\n\n```\n\n支持## ### 交替索引的目录\n\n关于api标签说明:\n\nmapping 对应项目中controller的mapping全路径     \nmethod  对应请求方式      \n\n编写文档的时候可以用markdown格式写清楚接口定义\n\n\n* 接口文档访问路径\n\nhttp://ip:port/md/xxx.md   \n\n例如：\nhttp://127.0.01:8080/md/index.md\n\n\n\n## 效果\n\n![](picture1.png)\n\n## 关于Test(接口测试)\n\n点击Test的时候会跳转到swagger2.8.0官网文档界面，然后会自动打开对应接口的调试界面。\n\n## 示例项目\n\nhttps://github.com/1991wangliang/demo-test\n\n\n## QA\n\nQ：当访问界面时遇到如下错误\n\n\n```\nWhitelabel Error Page This application has no explicit mapping for /error, so you are seeing this as a fallback.\n\nWed 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\n```\n\nA: 在项目的pom文件的properties下添加如下配置\n\n```\n\u003cthymeleaf.version\u003e3.0.9.RELEASE\u003c/thymeleaf.version\u003e\n\u003cthymeleaf-layout-dialect.version\u003e2.0.4\u003c/thymeleaf-layout-dialect.version\u003e\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlorne%2Fswaggerui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxlorne%2Fswaggerui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxlorne%2Fswaggerui/lists"}