{"id":13694868,"url":"https://github.com/wangyuheng/spring-boot-swagger-starter","last_synced_at":"2026-01-11T17:58:11.130Z","repository":{"id":57723971,"uuid":"77844516","full_name":"wangyuheng/spring-boot-swagger-starter","owner":"wangyuheng","description":"spring-boot项目快速添加swagger包括swagger-ui，用于管理接口文档以及页面调试","archived":false,"fork":false,"pushed_at":"2024-08-26T17:19:45.000Z","size":52,"stargazers_count":11,"open_issues_count":1,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-11-12T21:39:29.347Z","etag":null,"topics":["spring-boot","starter","swagger"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wangyuheng.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":"2017-01-02T15:55:26.000Z","updated_at":"2022-02-18T09:46:59.000Z","dependencies_parsed_at":"2022-09-02T06:53:58.851Z","dependency_job_id":null,"html_url":"https://github.com/wangyuheng/spring-boot-swagger-starter","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangyuheng%2Fspring-boot-swagger-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangyuheng%2Fspring-boot-swagger-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangyuheng%2Fspring-boot-swagger-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wangyuheng%2Fspring-boot-swagger-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wangyuheng","download_url":"https://codeload.github.com/wangyuheng/spring-boot-swagger-starter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252144545,"owners_count":21701428,"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":["spring-boot","starter","swagger"],"created_at":"2024-08-02T17:01:46.071Z","updated_at":"2026-01-11T17:58:11.086Z","avatar_url":"https://github.com/wangyuheng.png","language":"Java","funding_links":[],"categories":["Java"],"sub_categories":[],"readme":"# spring-boot-swagger-starter\nspring-boot项目快速添加swagger包括swagger-ui，用于管理接口文档以及页面调试\n## 使用方法\n**0.0.1已发布到maven中央仓库，欢迎使用**\n\n```xml\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.github.wangyuheng\u003c/groupId\u003e\n        \u003cartifactId\u003eswagger-starter\u003c/artifactId\u003e\n        \u003cversion\u003e0.0.1\u003c/version\u003e\n    \u003c/dependency\u003e\n```\n\n如果下载失败，可以发布starter到本地仓库\n在**SwaggerStarter**目录执行\n\n```\n    mvn clean install \n```\n\n此命令可以将jar添加进本地仓库\n\n### 运行demo\n在SwaggerStarterDemo目录执行\n\n```\n    mvn spring-boot:run \n```\n\n可以启动spring-boot项目，默认端口号为**8080**,在浏览器访问[http://localhost:8080/](http://localhost:8080/),可以看到demo接口事例。\n或者可以将项目导入常用IDE运行。\n### 编辑配置文件\n配置文件路径为 **spring-boot-swagger-starter/SwaggerStarterDemo/src/main/resources**，修改对应的配置项，重新启动可以在demo页面查看变动。\n\n#### 配置参数\n\n```yaml\n    swagger:\n      groupName: 分类(groupName)\n      title: 标题(title)\n      description: 介绍(description)\n      termsOfServiceUrl: 服务URL(termsOfServiceUrl)\n      version: 版本(version)\n      contactName: 作者名(contactName)\n      contactUrl: 作者主页(contactUrl)\n      contactEmail: 作者邮箱(contactEmail)\n      paths: /upload.*,/category.*\n      license:\n      licenseUrl:\n```\n\n## 设计\nstarter为方便项目使用，尽量简化，不添加无用依赖，自动化部分设置，留出配置文件方便定制化。\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwangyuheng%2Fspring-boot-swagger-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwangyuheng%2Fspring-boot-swagger-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwangyuheng%2Fspring-boot-swagger-starter/lists"}