创建第一个项目

sponge 支持创建多种类型后端服务项目，下面以创建一个包含 CRUD API 的 web 服务项目为例，这是最简单的创建方式之一，无需编写任何 Go 代码，仅需连接 MySQL 数据库即可生成完整、可直接部署的 web 服务项目。

前期准备

1. 确保已安装 MySQL 服务（可使用 docker-compose 脚本快速部署）。
2. 准备 MySQL 表，示例 用户表 SQL。

操作步骤

1. 点击左边菜单栏【SQL】→【创建 web 服务】；
2. 选择数据库mysql，填写数据库 dsn，然后点击按钮获取表名，选择表名(可多选)；
3. 填写其他参数，鼠标放在问号?位置可以查看参数说明；

填写完参数后，点击按钮下载代码生成 web 服务完整项目代码，如下图所示：

web-http

项目目录结构

.
├─ cmd
│   └─ user
│       ├─ initial
│       └─ main.go
├─ configs
├─ deployments
│   ├─ binary
│   ├─ docker-compose
│   └─ kubernetes
├─ docs
├─ internal
│   ├─ cache
│   ├─ config
│   ├─ dao
│   ├─ ecode
│   ├─ handler
│   ├─ model
│   ├─ routers
│   ├─ server
│   └─ types
└─ scripts

项目特点

• 技术栈基于 Gin+Gorm 框架
• 包含标准化的 CRUD API
• 支持自定义条件分页查询
• 集成 Swagger 文档生成工具
• 集成多种开箱即用的组件 (在配置文件configs/xxx.yml中可开启/关闭)

运行项目

# 生成 API 文档
make docs

# 编译并启动服务
make run

访问 http://localhost:8080/swagger/index.html 即可测试 API 接口：

web-http-swagger

提示

创建服务后进行开发的详细教程请参考 web 服务开发指南章节。