|
@@ -44,14 +44,14 @@
|
|
|
# 下载依赖(首次执行会按 go.mod 自动获取 Go 1.25.10 工具链)
|
|
# 下载依赖(首次执行会按 go.mod 自动获取 Go 1.25.10 工具链)
|
|
|
go mod download
|
|
go mod download
|
|
|
|
|
|
|
|
-# 启动服务,默认监听 0.0.0.0:8080
|
|
|
|
|
|
|
+# 启动服务,默认监听 0.0.0.0:8880
|
|
|
go run udeserver.go -f etc/udeserver-api.yaml
|
|
go run udeserver.go -f etc/udeserver-api.yaml
|
|
|
|
|
|
|
|
# 另开终端验证
|
|
# 另开终端验证
|
|
|
-curl http://127.0.0.1:8080/from/you
|
|
|
|
|
|
|
+curl http://127.0.0.1:8880/api/v1/from/you
|
|
|
# {"message":"Hello you"}
|
|
# {"message":"Hello you"}
|
|
|
|
|
|
|
|
-curl http://127.0.0.1:8080/db/ping
|
|
|
|
|
|
|
+curl http://127.0.0.1:8880/api/v1/db/ping
|
|
|
# {"ok":true,"version":"8.4.4","database":"ude"}
|
|
# {"ok":true,"version":"8.4.4","database":"ude"}
|
|
|
```
|
|
```
|
|
|
|
|
|
|
@@ -72,32 +72,81 @@ go build -o bin/udeserver.exe udeserver.go
|
|
|
| 密钥 `t_key` | `POST /keys` | `GET /keys` | `GET /keys/:id` | `PUT /keys/:id` | `DELETE /keys/:id` |
|
|
| 密钥 `t_key` | `POST /keys` | `GET /keys` | `GET /keys/:id` | `PUT /keys/:id` | `DELETE /keys/:id` |
|
|
|
| 服务 `t_service` | `POST /services` | `GET /services` | `GET /services/:id` | `PUT /services/:id` | `DELETE /services/:id` |
|
|
| 服务 `t_service` | `POST /services` | `GET /services` | `GET /services/:id` | `PUT /services/:id` | `DELETE /services/:id` |
|
|
|
|
|
|
|
|
|
|
+> 所有路由统一带 `/api/v1` 前缀,如 `GET /api/v1/keys/:id`。前缀在 `udeServer.api` 的 `@server(prefix: /api/v1)` 中配置,实际请求都需要加前缀;`/from/:name` 和 `/db/ping` 也不例外。
|
|
|
|
|
+
|
|
|
|
|
+### 统一响应格式
|
|
|
|
|
+
|
|
|
|
|
+所有接口(成功/失败)HTTP 状态恒为 `200`,返回 `{code, message, data}` 封装:
|
|
|
|
|
+
|
|
|
|
|
+```json
|
|
|
|
|
+{
|
|
|
|
|
+ "code": 100000,
|
|
|
|
|
+ "message": "操作成功",
|
|
|
|
|
+ "data": { "ok": true }
|
|
|
|
|
+}
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+业务码:
|
|
|
|
|
+
|
|
|
|
|
+| code | 含义 |
|
|
|
|
|
+| --- | --- |
|
|
|
|
|
+| 100000 | 操作成功 |
|
|
|
|
|
+| 100001 | 参数错误(如缺少 `name`、`id` 非法) |
|
|
|
|
|
+| 100002 | 资源不存在 |
|
|
|
|
|
+| 100003 | 服务器内部错误 |
|
|
|
|
|
+
|
|
|
|
|
+- 失败响应:`{"code":100xxx,"message":"错误描述","data":null}`,前端只需判断 `code`。
|
|
|
|
|
+- 全局封装在 `udeserver.go` 的 `response.Register()` 中注册,实现见 `internal/response/`。
|
|
|
|
|
+
|
|
|
|
|
+### 分页
|
|
|
|
|
+
|
|
|
|
|
+三个列表接口(目录/密钥/服务)统一支持分页,通过 query 参数传递:
|
|
|
|
|
+
|
|
|
|
|
+- `page`:页码,默认 `1`
|
|
|
|
|
+- `pageSize`:每页数量,默认 `10`,最大 `100`
|
|
|
|
|
+- 响应 `data`:`{"list":[...],"total":13}`,`total` 为总条数;超出范围时 `list` 为 `[]`
|
|
|
|
|
+
|
|
|
|
|
+示例:`GET /api/v1/keys?page=2&pageSize=5`
|
|
|
|
|
+
|
|
|
服务接口示例:
|
|
服务接口示例:
|
|
|
|
|
|
|
|
```powershell
|
|
```powershell
|
|
|
-# 新增:id 必填,三张表的主键都没有 AUTO_INCREMENT
|
|
|
|
|
-curl -X POST http://127.0.0.1:8080/services `
|
|
|
|
|
|
|
+# 新增服务:id 必填(t_service 主键没有 AUTO_INCREMENT)
|
|
|
|
|
+curl -X POST http://127.0.0.1:8880/api/v1/services `
|
|
|
-H "Content-Type: application/json" `
|
|
-H "Content-Type: application/json" `
|
|
|
-d "{\"id\":1,\"name\":\"demo\",\"ip\":\"10.0.0.1\",\"port\":\"8080\",\"iden\":\"svc-1\",\"keyIden\":\"key-1\",\"keyAlgo\":\"AES\",\"status\":\"active\"}"
|
|
-d "{\"id\":1,\"name\":\"demo\",\"ip\":\"10.0.0.1\",\"port\":\"8080\",\"iden\":\"svc-1\",\"keyIden\":\"key-1\",\"keyAlgo\":\"AES\",\"status\":\"active\"}"
|
|
|
|
|
|
|
|
# 列表 / 详情
|
|
# 列表 / 详情
|
|
|
-curl http://127.0.0.1:8080/services
|
|
|
|
|
-curl http://127.0.0.1:8080/services/1
|
|
|
|
|
|
|
+curl http://127.0.0.1:8880/api/v1/services
|
|
|
|
|
+curl http://127.0.0.1:8880/api/v1/services/1
|
|
|
|
|
|
|
|
# 更新:id 放在路径中,请求体为完整字段
|
|
# 更新:id 放在路径中,请求体为完整字段
|
|
|
-curl -X PUT http://127.0.0.1:8080/services/1 `
|
|
|
|
|
|
|
+curl -X PUT http://127.0.0.1:8880/api/v1/services/1 `
|
|
|
-H "Content-Type: application/json" `
|
|
-H "Content-Type: application/json" `
|
|
|
-d "{\"name\":\"demo-updated\",\"ip\":\"10.0.0.2\",\"port\":\"9090\",\"iden\":\"svc-1\",\"keyIden\":\"key-1\",\"keyAlgo\":\"SM4\",\"status\":\"disabled\"}"
|
|
-d "{\"name\":\"demo-updated\",\"ip\":\"10.0.0.2\",\"port\":\"9090\",\"iden\":\"svc-1\",\"keyIden\":\"key-1\",\"keyAlgo\":\"SM4\",\"status\":\"disabled\"}"
|
|
|
|
|
|
|
|
# 删除
|
|
# 删除
|
|
|
-curl -X DELETE http://127.0.0.1:8080/services/1
|
|
|
|
|
|
|
+curl -X DELETE http://127.0.0.1:8880/api/v1/services/1
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+密钥接口示例:
|
|
|
|
|
+
|
|
|
|
|
+```powershell
|
|
|
|
|
+# 新增密钥:前端只需要传 name
|
|
|
|
|
+curl -X POST http://127.0.0.1:8880/api/v1/keys `
|
|
|
|
|
+ -H "Content-Type: application/json" `
|
|
|
|
|
+ -d "{\"name\":\"demo-key\"}"
|
|
|
|
|
+
|
|
|
|
|
+# 返回:id 自增,iden/content 服务端生成,status 默认 1,createAt 由数据库生成
|
|
|
|
|
+# {"code":100000,"message":"操作成功","data":{"id":1,"iden":"4532bb4cefb944889d847020211ba7c7","name":"demo-key","content":"5e35...","status":"1","createAt":"2026-10-21T10:07:26+08:00"}}
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
说明:
|
|
说明:
|
|
|
|
|
|
|
|
|
|
+- 密钥生成规则:`iden` 为去掉 `-` 的 UUIDv4;`content` 使用 PBKDF2-HMAC-SHA256(10 万次迭代、输出 32 字节、随机种子,`iden` 作盐)生成并转为十六进制;`status` 固定为 `"1"`;`id`、`create_at` 由数据库生成。
|
|
|
- `PUT` 为全量更新,未传的可选字段会写成 `NULL`(空字符串、`serviceId=0` 均按 `NULL` 处理)。
|
|
- `PUT` 为全量更新,未传的可选字段会写成 `NULL`(空字符串、`serviceId=0` 均按 `NULL` 处理)。
|
|
|
-- 列表接口返回全部数据,暂未分页。
|
|
|
|
|
-- 错误响应统一为 `{"code":404,"msg":"service id=1 not found"}` 格式。
|
|
|
|
|
|
|
+- 列表接口均已分页(见上),按 `id` 升序返回。
|
|
|
|
|
+- 错误响应见「统一响应格式」一节,业务码 `100001~100003`。
|
|
|
|
|
|
|
|
## 修改接口
|
|
## 修改接口
|
|
|
|
|
|
|
@@ -117,13 +166,13 @@ C:\Users\Administrator\go\bin\goctl.exe api go -api udeServer.api -dir .
|
|
|
```yaml
|
|
```yaml
|
|
|
Name: udeServer-api
|
|
Name: udeServer-api
|
|
|
Host: 0.0.0.0
|
|
Host: 0.0.0.0
|
|
|
-Port: 8080
|
|
|
|
|
|
|
+Port: 8880
|
|
|
|
|
|
|
|
MySQL:
|
|
MySQL:
|
|
|
DataSource: "ude:H3G8xzfYpAASYFxF@tcp(10.10.10.30:3306)/ude?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai"
|
|
DataSource: "ude:H3G8xzfYpAASYFxF@tcp(10.10.10.30:3306)/ude?charset=utf8mb4&parseTime=true&loc=Asia%2FShanghai"
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
-> 说明:goctl 生成的默认端口是 8888,但本机 8888 已被另一个 GoLand 服务占用,因此改为 8080。
|
|
|
|
|
|
|
+> 说明:goctl 生成的默认端口是 8888,当前配置使用 8880。
|
|
|
>
|
|
>
|
|
|
> 数据库密码目前以明文写在配置中,请勿提交到公开仓库;生产环境建议使用环境变量或密钥管理服务注入。
|
|
> 数据库密码目前以明文写在配置中,请勿提交到公开仓库;生产环境建议使用环境变量或密钥管理服务注入。
|
|
|
|
|
|
|
@@ -141,7 +190,7 @@ err := l.svcCtx.DB.QueryRowCtx(l.ctx, &count, "SELECT COUNT(*) FROM your_table")
|
|
|
```
|
|
```
|
|
|
|
|
|
|
|
- 已为三张表生成 model(`internal/model/`):`TDirectoryModel`、`TKeyModel`、`TServiceModel`,并在自定义 model 文件中补充了列表查询 `FindAll`。
|
|
- 已为三张表生成 model(`internal/model/`):`TDirectoryModel`、`TKeyModel`、`TServiceModel`,并在自定义 model 文件中补充了列表查询 `FindAll`。
|
|
|
-- 三张表的主键都是普通 `int`,没有 `AUTO_INCREMENT`,因此新增接口必须显式传 `id`。
|
|
|
|
|
|
|
+- `t_directory`、`t_service` 的主键是普通 `int`,没有 `AUTO_INCREMENT`,新增时必须显式传 `id`;`t_key.id` 为自增主键,新增时不需要传。
|
|
|
- 新增表后可按表继续生成 model:
|
|
- 新增表后可按表继续生成 model:
|
|
|
|
|
|
|
|
```powershell
|
|
```powershell
|