{"id":19990117,"url":"https://github.com/cn-src/swagger-document-ui","last_synced_at":"2025-05-04T09:34:29.177Z","repository":{"id":57715960,"uuid":"145932082","full_name":"cn-src/swagger-document-ui","owner":"cn-src","description":"Swagger 文档型 UI","archived":false,"fork":false,"pushed_at":"2021-10-16T07:07:27.000Z","size":9165,"stargazers_count":12,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2023-07-28T00:18:26.785Z","etag":null,"topics":["springfox","springfox-swagger-ui","swagger","swagger-ui"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cn-src.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-08-24T02:30:05.000Z","updated_at":"2020-11-19T05:44:15.000Z","dependencies_parsed_at":"2022-09-12T08:41:49.196Z","dependency_job_id":null,"html_url":"https://github.com/cn-src/swagger-document-ui","commit_stats":null,"previous_names":[],"tags_count":10,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cn-src%2Fswagger-document-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cn-src%2Fswagger-document-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cn-src%2Fswagger-document-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cn-src%2Fswagger-document-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cn-src","download_url":"https://codeload.github.com/cn-src/swagger-document-ui/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224391390,"owners_count":17303609,"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":["springfox","springfox-swagger-ui","swagger","swagger-ui"],"created_at":"2024-11-13T04:50:59.998Z","updated_at":"2024-11-13T04:51:13.106Z","avatar_url":"https://github.com/cn-src.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)\n[![Build Status](https://travis-ci.org/cn-src/swagger-document-ui.svg?branch=dev)](https://travis-ci.org/cn-src/swagger-document-ui)\n[![Maven Central](https://img.shields.io/maven-central/v/cn.javaer.springfox/swagger-document-ui.svg)](https://search.maven.org/search?q=g:cn.javaer.springfox%20AND%20a:swagger-document-ui\u0026core=gav)\n[![star](https://gitee.com/cn-src/swagger-document-ui/badge/star.svg?theme=dark)](https://gitee.com/cn-src/swagger-document-ui/stargazers)\n\n# Swagger 规范接口的 UI\n\n---\n\n-   主要体现文档的可读性功能，给接口调用者提供接口文档，省去文档编写。\n-   此项目没有类似官方的在线测试/调试功能，建议使用 Postman，Postman 默认支持 swagger 规范的接口导入，但文件夹结构不与文档一致，所以定制了 Postman 导出功能。\n-   [在线样例](http://cn-src.gitee.io/swagger-document-ui/swagger-ui.html)\n-   [更新日志](https://github.com/cn-src/swagger-document-ui/releases)\n\n# 使用方式\n\n## springfox 框架集成\n\n-   [springfox 官方文档](http://springfox.github.io/springfox/docs/current/)\n\n1. 移除官方 UI 依赖\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.springfox\u003c/groupId\u003e\n    \u003cartifactId\u003espringfox-swagger-ui\u003c/artifactId\u003e\n    \u003cversion\u003e${springfox.version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n2. 添加 swagger-document-ui 依赖\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecn.javaer.springfox\u003c/groupId\u003e\n    \u003cartifactId\u003eswagger-document-ui\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## Spring Boot 集成\n\n与 Spring Boot 集成使用是最简单的方式，推荐使用 [程序猿 DD/spring-boot-starter-swagger](https://gitee.com/didispace/spring-boot-starter-swagger)\n提供的集成方式，然后你需要：\n\n1. 排除自带 UI 依赖\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.spring4all\u003c/groupId\u003e\n    \u003cartifactId\u003eswagger-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e${swagger-spring-boot-starter.version}\u003c/version\u003e\n    \u003c!--排除自带 UI 依赖--\u003e\n    \u003cexclusions\u003e\n        \u003cexclusion\u003e\n            \u003cartifactId\u003espringfox-swagger-ui\u003c/artifactId\u003e\n            \u003cgroupId\u003eio.springfox\u003c/groupId\u003e\n        \u003c/exclusion\u003e\n    \u003c/exclusions\u003e\n\u003c/dependency\u003e\n```\n\n2. 添加 swagger-document-ui 依赖\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecn.javaer.springfox\u003c/groupId\u003e\n    \u003cartifactId\u003eswagger-document-ui\u003c/artifactId\u003e\n    \u003cversion\u003e1.0.2\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\n## 静态资源部署\n\n\u003e 此项目最终是生成纯静态资源，只要将 dist 目录里的静态文件部署到 web 服务器下即可使用，但前提是：你的项目中使用了 swagger 规范的 API 信息接口。\n\n1. 其会请求 `/swagger-resources` （springfox 框架默认地址） 和 `/swagger-resources.json` （本项目新增地址） 拿到 API 信息接口地址。\n2. 请求 `swagger-resources` 中配置的 `url`（优先） 或者 `location`（兼容旧版不提供 url 字段） 其应当返回 swagger 规范的 API 信息即可使用。\n3. 可参考在线样例的部署方式，分支：[online-demo](https://gitee.com/cn-src/swagger-document-ui/tree/online-demo/)\n\n# 效果预览\n\n## 右侧文档锚点导航\n\n![](docs/demo1.png)\n\n## 分组选择 API\n\n![](docs/demo2.png)\n\n## 模糊搜索\n\n-   支持中文，拼音，英文\n-   可搜索 API 名称，分类名称，url 路径\n\n![](docs/demo3.png)\n\n## 导出 Postman\n\n![](docs/demo4.png)\n![](docs/postman1.png)\n![](docs/postman2.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcn-src%2Fswagger-document-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcn-src%2Fswagger-document-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcn-src%2Fswagger-document-ui/lists"}