{"id":15102606,"url":"https://github.com/fxbin/swagger-spring-boot-starter","last_synced_at":"2026-02-06T12:37:31.979Z","repository":{"id":43118369,"uuid":"392614085","full_name":"fxbin/swagger-spring-boot-starter","owner":"fxbin","description":"自制 swagger spring-boot-starter, 默认集成 knife4j, 界面更加友好，同时使用便捷， 一键集成sringboot 项目，同时支持一键开启网关聚合功能，使你解脱书写、配置API文档的烦恼...","archived":false,"fork":false,"pushed_at":"2023-11-24T06:48:00.000Z","size":488,"stargazers_count":1,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-23T15:38:13.665Z","etag":null,"topics":["knife4j","spring-cloud","springboot","swagger-docs"],"latest_commit_sha":null,"homepage":"","language":"Java","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/fxbin.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-04T08:43:06.000Z","updated_at":"2024-01-06T16:33:03.000Z","dependencies_parsed_at":"2024-10-31T03:35:16.205Z","dependency_job_id":null,"html_url":"https://github.com/fxbin/swagger-spring-boot-starter","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fxbin/swagger-spring-boot-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fxbin%2Fswagger-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fxbin%2Fswagger-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fxbin%2Fswagger-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fxbin%2Fswagger-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fxbin","download_url":"https://codeload.github.com/fxbin/swagger-spring-boot-starter/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fxbin%2Fswagger-spring-boot-starter/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29160816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-06T07:18:23.844Z","status":"ssl_error","status_checked_at":"2026-02-06T07:13:32.659Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["knife4j","spring-cloud","springboot","swagger-docs"],"created_at":"2024-09-25T19:03:08.701Z","updated_at":"2026-02-06T12:37:31.944Z","avatar_url":"https://github.com/fxbin.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# swagger-spring-boot-starter\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/70cd38871b8041f0a4f9c93d44c59c93)](https://www.codacy.com/gh/fxbin/swagger-spring-boot-starter/dashboard?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=fxbin/swagger-spring-boot-starter\u0026amp;utm_campaign=Badge_Grade)\n[![Spring Boot](https://img.shields.io/badge/SpringBoot-2.5.3-brightgreen.svg)](https://github.com/spring-projects/spring-boot)\n[![Spring Cloud](https://img.shields.io/badge/SpringCloud-2020.0.3-brightgreen.svg)](https://github.com/spring-cloud)\n[![Knife4j](https://img.shields.io/badge/Knife4j-3.0.3-brightgreen.svg)](https://gitee.com/xiaoym/knife4j)\n\n```\n自制 swagger spring-boot-starter, 默认集成 knife4j, 界面更加友好，同时使用便捷，一键集成sringboot 项目，\n同时支持一键开启网关聚合功能，使你解脱书写、配置Swagger API文档的烦恼...\n```\n\n| 依赖 | 版本       |\n---|----------\n| Spring Boot | 2.5.3    |\n| Spring Cloud | 2020.0.3 | \n| Knife4j | 3.0.3    |  \n\n* 注意： 笔者仅测试过如上版本的使用情况，低版本请自行测试\n\n## 使用步骤\n\nPS: `最新版为1.4`\n\n1. 添加 maven 依赖\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecn.fxbin.swagger\u003c/groupId\u003e\n    \u003cartifactId\u003eswagger-spring-boot-starter\u003c/artifactId\u003e\n    \u003cversion\u003e${currentVersion}\u003c/version\u003e\n\u003c/dependency\u003e\n```\nPS: 已发布中央仓库，可直接引用\n\n2. 修改配置文件\n\n```yaml\nspring:\n  swagger:\n    enabled: true\n\n  # 如果使用 2.6.X 以上版本，需增加如下配置，否则不生效\n  mvc:\n    pathmatch:\n      matching-strategy: ant_path_matcher\n```\n\n更多配置属性参考：\n\n![配置属性](doc/swagger%20配置属性.png)\n\n## 其它注意事项\n\n与网关集成时，默认按照 `spring.cloud.gateway.discovery.locator.enabled` 配置项来决定是否开启动态文档，默认读取文件配置\n\n## 参考文档\n[knife4j doc](https://doc.xiaominfo.com/knife4j/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffxbin%2Fswagger-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffxbin%2Fswagger-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffxbin%2Fswagger-spring-boot-starter/lists"}