# api-desgin

## URL spec

```
/api/v1/${resources}

/api/v1/${resources}/${resource_id}
```

## id spec

保留的 id 为单字母，所以一个正常的 id 必须大于一个字母，建立使用带前缀的方式进行命名

单字线保留表

| 保留字母 | 备注 |
| ---- | ---- |
| `_` | 用于表示不与任何一个 id 绑定 |


常见前缀及命名方法：

| 命名方法 | 示例 |
| ---- | ---- |
| 小写 + 前缀 + 数字序列 | user_123456 |
| 小写 + 前缀 + 16字节随机数(base32) | user_z3ymhvyxtzvxjyewrsqf5ozgya |
| 大写 + 前缀 + 16字节随机数(base58) | USERVQ5sS43wpZJycVgPPhwFwh |