杭州明婳科技
deb3cc71bf
按报告 v1.0.4 路线图完成 5 项开发体验与文档改进： #25 模块路径文档改进： - 保留 -core 后缀（xlgo 是多产品系列：xlgo-core/xlgo-orm/xlgo-ai） - README 快速开始补完整 import 示例 + 新增「模块路径与包名」小节 - CLAUDE.md Import Path Note 措辞明确化 #27 Without* Option 定位文档化： - 调研确认 Without* 有真实用例（测试覆盖 + NewFullStack 后排除单项） - 不删不标 Deprecated，在 app.go 注释 + README 说明其定位 #28 CLI 多模板： - xlgo new --template minimal/api/fullstack - minimal 轻量HTTP无依赖，api 标准业务分层（默认），fullstack 全组件 - 三模板实测生成正确 #29 examples/ 目录： - examples/minimal（50行可跑，无外部依赖） - examples/full（mysql+redis+jwt+user CRUD） - examples/README.md #30 文档结构： - Version_*.md + report.md 移到 docs/plans/（v2.0-review.md） - 新增 docs/README.md 索引 - CHANGELOG/GUIDE 留根目录（按惯例） - .gitignore 整理 build/vet/test + examples 编译全绿。 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
43 lines
1.3 KiB
Markdown
43 lines
1.3 KiB
Markdown
# xlgo 示例
|
||
|
||
两个可运行示例，帮助快速上手 xlgo。
|
||
|
||
## minimal — 最小 HTTP 服务
|
||
|
||
不依赖 MySQL / Redis / Storage，纯 HTTP + 健康检查。第一次接触 xlgo 从这里开始。
|
||
|
||
```bash
|
||
go run ./examples/minimal
|
||
```
|
||
|
||
访问 http://localhost:8081/health（健康检查）与 http://localhost:8081/api/v1/（示例路由）。
|
||
|
||
## full — 完整业务 API
|
||
|
||
包含 MySQL + Redis + JWT + 一个 user CRUD（登录发 token、认证路由、创建/查询用户）。
|
||
|
||
**运行前需准备**：
|
||
- MySQL（修改 `examples/full/config.yaml` 的 `database` 配置）
|
||
- Redis（修改 `examples/full/config.yaml` 的 `redis` 配置）
|
||
|
||
```bash
|
||
go run ./examples/full
|
||
```
|
||
|
||
启动后自动迁移 user 表。接口：
|
||
|
||
| 方法 | 路径 | 说明 | 认证 |
|
||
|---|---|---|---|
|
||
| POST | /api/v1/login | 登录，返回 token | 否 |
|
||
| GET | /api/v1/users/:id | 查询用户 | 是（Bearer token） |
|
||
| POST | /api/v1/users | 创建用户 | 是（Bearer token） |
|
||
|
||
登录示例：
|
||
```bash
|
||
curl -X POST http://localhost:8082/api/v1/login \
|
||
-H "Content-Type: application/json" \
|
||
-d '{"username":"alice","password":"secret"}'
|
||
```
|
||
|
||
> 示例代码为演示用途，密码明文存储、未做参数校验，生产环境请使用 bcrypt 哈希密码并配合 `validation` 包校验入参。
|