init: test-contract 契约仓库初始化
This commit is contained in:
commit
96fc06b1fe
|
|
@ -0,0 +1,30 @@
|
||||||
|
# test-contract — 接口契约
|
||||||
|
|
||||||
|
前后端共享的接口协议文件。修改接口前先改本仓库,再同步。
|
||||||
|
|
||||||
|
## 目录
|
||||||
|
|
||||||
|
- `admin/` — 管理后台接口
|
||||||
|
- `app/` — 移动端/H5/小程序接口
|
||||||
|
- `auth/` — 登录注册接口(前后端共享)
|
||||||
|
- `open/` — 对外开放接口
|
||||||
|
|
||||||
|
## 契约模板
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
## /admin/xxx/list
|
||||||
|
GET,分页查询
|
||||||
|
|
||||||
|
入参:
|
||||||
|
page int 页码,默认1
|
||||||
|
size int 每页条数,默认10
|
||||||
|
|
||||||
|
返回:
|
||||||
|
{ code: 200, data: { list: [...], total: 100, pages: 10, current: 1, size: 10 } }
|
||||||
|
```
|
||||||
|
|
||||||
|
## 同步规则
|
||||||
|
|
||||||
|
1. 改接口 → 改本仓库对应文档 → push
|
||||||
|
2. 通知对方 `git submodule update --remote contract/`
|
||||||
|
3. 契约文件为准,不一致以契约为准
|
||||||
|
|
@ -0,0 +1,8 @@
|
||||||
|
# 状态值映射表
|
||||||
|
|
||||||
|
> 前后端状态值统一约定。修改此处 = 修改协议,必须同步两端。
|
||||||
|
|
||||||
|
| 含义 | 后端值 | 前端显示 | 前端 CSS 类 |
|
||||||
|
|------|--------|----------|------------|
|
||||||
|
| 启用 | 1 | 启用 | success |
|
||||||
|
| 禁用 | 0 | 禁用 | danger |
|
||||||
Loading…
Reference in New Issue