{"id":17249452,"url":"https://github.com/inhere/go-revel-skeleton","last_synced_at":"2025-03-26T06:15:13.110Z","repository":{"id":82402552,"uuid":"110511358","full_name":"inhere/go-revel-skeleton","owner":"inhere","description":"a go app skeleton by revel, add swagger-ui, go-swagger","archived":false,"fork":false,"pushed_at":"2018-05-08T12:50:58.000Z","size":2,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T07:42:16.136Z","etag":null,"topics":["application-skeleton","go-revel-skeleton","go-swagger","golang","revel","swagger-ui"],"latest_commit_sha":null,"homepage":"","language":null,"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/inhere.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":"2017-11-13T06:55:32.000Z","updated_at":"2018-05-08T12:50:59.000Z","dependencies_parsed_at":"2023-06-15T13:00:13.989Z","dependency_job_id":null,"html_url":"https://github.com/inhere/go-revel-skeleton","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/inhere%2Fgo-revel-skeleton","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhere%2Fgo-revel-skeleton/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhere%2Fgo-revel-skeleton/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inhere%2Fgo-revel-skeleton/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inhere","download_url":"https://codeload.github.com/inhere/go-revel-skeleton/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245598315,"owners_count":20641884,"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":["application-skeleton","go-revel-skeleton","go-swagger","golang","revel","swagger-ui"],"created_at":"2024-10-15T06:44:25.815Z","updated_at":"2025-03-26T06:15:13.091Z","avatar_url":"https://github.com/inhere.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# application\n\ngo 框架 revel 配合 swagger-ui 应用骨架搭建介绍\n\n## [当前项目](project.md)\n\n## 相关项目\n\n- `revel` 一个全栈式 golang 框架 \n- `go-swagger` 通过注释生成 `swagger.json`\n- `swagger-ui` 显示API文档。 将 `swagger.json` 渲染成 html\n\n## revel\n\n- github https://github.com/revel/revel\n- 官方模块 https://github.com/revel/modules\n- 官方文档 https://revel.github.io\n- 另一份文档 https://git-books.github.io/books/revel/\n- 另一份文档 https://git-books.gitee.io/books/revel/\n\n### 安装revel\n\n```sh\ngo get -u -v github.com/revel/cmd/revel\nrevel -h\n```\n\n### 创建项目\n\n```sh\ncd $GOPATH/src\nrevel new {PROJECT_NAME}\nll {PROJECT_NAME}\n```\n\n### 运行项目\n\n转到项目目录下执行 `revel run` 访问 `http://localhost:9000/`\n\n## go-swagger\n\n用于生成 swagger-ui 可读的json 文档文件\n\n- 文档 https://goswagger.io/\n- Github https://github.com/go-swagger/go-swagger\n\n### 安装 \n\n```sh\ngo get -u -v github.com/go-swagger/go-swagger/cmd/swagger\nswagger -h\n```\n\n### 文档生成\n\n在项目目录执行\n\n```sh\nswagger generate spec -o swagger-ui/docs/swagger.json\nswagger generate spec -i ./swagger.yml -o swagger-ui/docs/swagger.json\n```\n\n\u003e 因为 revel 的 `main.go` 是自动生成到 `app/tmp` 的，所以需要到 `main.go` 所在目录运行上述命令才行\n\n```sh\ncd app/tmp\nswagger generate spec -o ../../swagger-ui/docs/swagger.json\n```\n\n### swagger-ui \n\nswagger-ui 下载 `npm install swagger-ui-dist`。或者到 github 下载\n\n拷贝 `dist` 下的所有文件到项目目录下 `swagger-ui` 目录\n\n- github https://github.com/swagger-api/swagger-ui\n\n## 文档查看\n\n- 配置静态资源访问\n\n路由配置 `conf/routes`\n\n```\n# For swagger UI\nGET    /swagger-ui/*filepath                   Static.Serve(\"swagger-ui\")\nGET    /swagger-ui/                            Static.Serve(\"swagger-ui\",\"index.html\")\n```\n\n- 访问： `127.0.0.1:9000/swagger-ui/`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finhere%2Fgo-revel-skeleton","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finhere%2Fgo-revel-skeleton","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finhere%2Fgo-revel-skeleton/lists"}