feat: 添加环境变量管理工具和部署配置改版
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m33s
All checks were successful
构建并部署到测试环境(无 SSH) / build-and-deploy (push) Successful in 5m33s
主要改动: - 新增交互式环境配置脚本 (scripts/setup-env.sh) - 新增本地启动快捷脚本 (scripts/run-local.sh) - 新增环境变量模板文件 (.env.example) - 部署模式改版:使用嵌入式配置 + 环境变量覆盖 - 添加对象存储功能支持 - 改进 IoT 卡片导入任务 - 优化 OpenAPI 文档生成 - 删除旧的配置文件,改用嵌入式默认配置
This commit is contained in:
@@ -173,15 +173,65 @@ func registerXxxRoutes(
|
||||
|
||||
```go
|
||||
type RouteSpec struct {
|
||||
Summary string // 操作摘要(中文,简短)
|
||||
Input interface{} // 请求参数 DTO
|
||||
Output interface{} // 响应结果 DTO
|
||||
Tags []string // 分类标签(用于文档分组)
|
||||
Auth bool // 是否需要认证
|
||||
Summary string // 操作摘要(中文,简短,一行)
|
||||
Description string // 详细说明,支持 Markdown 语法(可选)
|
||||
Input interface{} // 请求参数 DTO
|
||||
Output interface{} // 响应结果 DTO
|
||||
Tags []string // 分类标签(用于文档分组)
|
||||
Auth bool // 是否需要认证
|
||||
}
|
||||
```
|
||||
|
||||
### 4. 完整示例
|
||||
### 4. Description 字段(Markdown 说明)
|
||||
|
||||
`Description` 字段用于添加接口的详细说明,支持 **CommonMark Markdown** 语法。Apifox 等 OpenAPI 工具会正确渲染这些 Markdown 内容。
|
||||
|
||||
**使用场景**:
|
||||
- 业务规则说明
|
||||
- 请求频率限制
|
||||
- 注意事项
|
||||
- 错误码说明
|
||||
- 数据格式说明
|
||||
|
||||
**示例**:
|
||||
```go
|
||||
Register(router, doc, basePath, "POST", "/login", handler.Login, RouteSpec{
|
||||
Summary: "后台登录",
|
||||
Description: `## 登录说明
|
||||
|
||||
**请求频率限制**:每分钟最多 10 次
|
||||
|
||||
### 注意事项
|
||||
1. 密码错误 5 次后账号将被锁定 30 分钟
|
||||
2. Token 有效期为 24 小时
|
||||
|
||||
### 返回码说明
|
||||
| 错误码 | 说明 |
|
||||
|--------|------|
|
||||
| 1001 | 用户名或密码错误 |
|
||||
| 1002 | 账号已被锁定 |
|
||||
`,
|
||||
Tags: []string{"认证"},
|
||||
Input: new(dto.LoginRequest),
|
||||
Output: new(dto.LoginResponse),
|
||||
Auth: false,
|
||||
})
|
||||
```
|
||||
|
||||
**支持的 Markdown 语法**:
|
||||
- 标题:`#`、`##`、`###`
|
||||
- 列表:`-`、`1.`
|
||||
- 表格:`| 列1 | 列2 |`
|
||||
- 代码:`` `code` `` 和 ` ```code block``` `
|
||||
- 强调:`**粗体**`、`*斜体*`
|
||||
- 链接:`[文本](url)`
|
||||
|
||||
**最佳实践**:
|
||||
- 保持简洁,控制在 500 字以内
|
||||
- 使用结构化的 Markdown(标题、列表、表格)提高可读性
|
||||
- 避免使用 HTML 标签(兼容性较差)
|
||||
|
||||
### 5. 完整示例
|
||||
|
||||
```go
|
||||
func registerShopRoutes(router fiber.Router, handler *admin.ShopHandler, doc *openapi.Generator, basePath string) {
|
||||
|
||||
Reference in New Issue
Block a user