{"id":15470575,"url":"https://github.com/artfoxe6/quick-gin","last_synced_at":"2025-04-22T12:12:12.526Z","repository":{"id":88716648,"uuid":"249184647","full_name":"artfoxe6/quick-gin","owner":"artfoxe6","description":":heart: 基于gin的一个轻量api骨架","archived":false,"fork":false,"pushed_at":"2025-04-09T08:31:25.000Z","size":10663,"stargazers_count":8,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-04-09T09:35:24.299Z","etag":null,"topics":["api","gin","quickstart"],"latest_commit_sha":null,"homepage":"","language":"Go","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/artfoxe6.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":"2020-03-22T13:03:27.000Z","updated_at":"2025-04-09T08:31:28.000Z","dependencies_parsed_at":"2024-06-21T17:42:51.664Z","dependency_job_id":"35cca508-0445-4b7a-83b6-84acdc3bd81d","html_url":"https://github.com/artfoxe6/quick-gin","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/artfoxe6%2Fquick-gin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artfoxe6%2Fquick-gin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artfoxe6%2Fquick-gin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artfoxe6%2Fquick-gin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artfoxe6","download_url":"https://codeload.github.com/artfoxe6/quick-gin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250237832,"owners_count":21397401,"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":["api","gin","quickstart"],"created_at":"2024-10-02T02:05:30.946Z","updated_at":"2025-04-22T12:12:12.509Z","avatar_url":"https://github.com/artfoxe6.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# quick-gin\n基于```gin```的一个轻量```api```骨架，可以帮助你快速开始业务开发\n\n#### 概括\n之前做过其他语言的Web开发，切换到gin后会感觉少了点什么，最明显的一点他没有提供一个推荐或默认的目录结构\u003cbr\u003e\n比如常见的```controller```，```model```，```service```，```repository```等等\u003cbr\u003e\n这会造成新手不知道如何去组织和划分代码\u003cbr\u003e\n还有就是没有提供一些开箱即用的Web通用组件，比如数据库，缓存等\n\n#### 目录结构\n  ```bash\n    project\n    ├── build 二进制文件打包目录\n    ├── cmd 应用目录，可能存放多个应用\n    │   └── app 具体的应用，名字根据业务来取就行\n    │       └── main.go 应用的入口，只负责启动服务，不应该涉及业务代码\n    ├── config 配置目录\n    │   ├── config.ini 这个文件一般不应该提交\n    │   └── config.ini.example\n    ├── go.mod\n    ├── go.sum\n    ├── internal 由于业务项目一般是不对外公开的，也不存在被其他项目导入的可能，所以放到internal中\n    │   ├── app 对应cmd里面的具体应用\n    │   │   ├── api =\u003e controller\n    │   │   │   ├── base.go \n    │   │   ├── model 这里面只定义模型和关联关系，不建议在这里写CRUD\n    │   │   │   ├── base.go\n    │   │   ├── router.go 路由\n    │   │   └── service\n    │   │       ├── student.go\n    │   └── pkg\n    ├── LICENSE\n    ├── log\n    │   ├── req20230513.log\n    │   └── runtime.log\n    ├── Makefile\n    ├── readme.md\n    └── test\n  ```\n\n#### 开始使用\n- 克隆仓库到本地\n- 初始化项目，根据自己的系统选择\n  ```\n    ./quick-cli github.com/xxx/myblog\n    ./quick-cli-mac github.com/xxx/myblog\n    ./quick-cli.exe github.com/xxx/myblog\n  ```\n- 启动服务\n  ```\n  make\n  ```\n    详情查看Makefile文件，里面定义几种常用命令\u003cbr\u003e\n    make build 打包应用\u003cbr\u003e\n    make stop 停止服务\u003cbr\u003e\n    make run 启动服务\u003cbr\u003e\n    make restart 等于 build+stop+run，不带参数时默认执行这个\u003cbr\u003e\n    之所以用make方式是因为现在网络上很多开源Golang项目都在用\u003cbr\u003e\n    如果不喜欢你依然可以使用 go run cmd/main.go 这种方式\u003cbr\u003e\n\n\n#### 温馨提示\n- 根目录结构参考自 https://github.com/golang-standards/project-layout\n- 业务层次结构参考了一些开源项目，然后结合一些自己的经验摸索出来的，大家可以参考借鉴，不一定适用所有项目，\u003cbr\u003e\n  如果有更加优雅的组织方式，欢迎留言讨论\n- 每一个业务层具体干什么这里在啰嗦一下 \n  \u003econtroller层 参数验证，返回处理结果\n  \u003e \n  \u003emodel层 推荐只定义模型和关联关系，不涉及CRUD,\n  但是如果你的项目极小，可以考虑在这里写CRUD，砍掉service层，\n  相当于把service层的功能分摊到model和controller层了\n  \u003e \n  \u003eservice层 业务逻辑，调用各种pkg,数据库CRUD\n  但是如果你的项目很复杂，可能需要复用或者缓存CURD，这个时候你可以在抽一个repository层出来专门处理数据库,\n  相当于把service在细拆\n\n\n    \n\n    ","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartfoxe6%2Fquick-gin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartfoxe6%2Fquick-gin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartfoxe6%2Fquick-gin/lists"}