Files
api-desgin/README.md
2021-10-28 08:28:09 +08:00

21 lines
353 B
Markdown

# api-desgin
## URL spec
```
/api/v1/${resources}
/api/v1/${resources}/${resource_id}
```
## id spec
保留的 id 为单字母,所以一个正常的 id 必须大于一个字母,建立使用小写和带前缀的方式进行命名
单字线保留表
| 保留字母 | 备注 |
| ---- | ---- |
| `_` | 用于表示不与任何一个 id 绑定 |