-
Notifications
You must be signed in to change notification settings - Fork 0
hyp api.md
maoxiaoyue edited this page Apr 14, 2026
·
1 revision
建立僅有 API 結構的 HypGo 專案,不含靜態檔案和前端模板。適合微服務和後端 API。
hyp api <project-name>
hyp api myapi && cd myapi && go mod tidy hyp ai-rules # 必要:生成 AI 配置檔
myapi/
├── app/
│ ├── controllers/
│ ├── models/
│ └── services/
├── config/config.yaml
├── main.go
└── go.mod
| 項目 | hyp new |
hyp api |
|---|---|---|
| 靜態檔案(static/) | ✅ | ❌ |
| HTML 模板(templates/) | ✅ | ❌ |
| 歡迎頁面 | ✅ | ❌ |
| API 路由 | ✅ | ✅ |
| MVC 結構 | ✅ | ✅ |
- hyp new — 全棧專案
- hyp generate — 生成程式碼
設計文件
套件
- config — 設定
- context — 請求上下文
- router — 路由器
- server — 伺服器
- middleware — 中介層
- websocket — WebSocket
- hidb — 資料庫 ORM
- hidb/cassandra — Cassandra
- logger — 日誌
- json — JSON 處理
- grpc — gRPC
AI 協作工具鏈
- schema — Schema-first 路由
- manifest — 專案 Manifest
- contract — Contract Testing
- errors — Typed Error Catalog
- migrate — Migration Diff
- scaffold — 智慧 Scaffold
- airules — AI Rules
CLI 命令
- hyp 總覽
- hyp new
- hyp api
- hyp run
- hyp restart
- hyp generate
- hyp migrate
- hyp context
- hyp ai-rules
- hyp chkcomment
- hyp impact
- hyp docker
- hyp health
- hyp version
- hyp difflog
Design Docs
Packages
- config — Configuration
- context — Request Context
- router — Router
- server — Server
- middleware — Middleware
- websocket — WebSocket
- hidb — Database ORM
- hidb/cassandra - Cassandra 5.0
- logger — Logger
- json — JSON
- grpc — gRPC
AI Collaboration Toolchain
- schema — Schema-first Routing
- manifest — Project Manifest
- contract — Contract Testing
- errors — Typed Error Catalog
- migrate — Migration Diff
- scaffold — Smart Scaffold
- airules — AI Rules
CLI Commands