|
1 år sedan | |
---|---|---|
api | 1 år sedan | |
cmd | 1 år sedan | |
configs @ c29df25e93 | 1 år sedan | |
internal | 1 år sedan | |
pkg | 1 år sedan | |
third_party | 1 år sedan | |
.gitignore | 1 år sedan | |
.gitmodules | 1 år sedan | |
Dockerfile | 1 år sedan | |
LICENSE | 1 år sedan | |
Makefile | 1 år sedan | |
README.md | 1 år sedan | |
docker-compose.yaml | 1 år sedan | |
go.mod | 1 år sedan | |
go.sum | 1 år sedan | |
openapi.yaml | 1 år sedan |
语义化URL的好处在于可一眼看出URL的功能。上图提供了URL的前缀,我们通过前传加上语义结尾的URL即可得到完整的URL地址。
比如我们现在要绑定设备,我们通过上述图中理解可以得到绑定设备属于设备规范,绑定设备我们的语义结尾是 bind
, 那么完整的URL地址应该是
/apis/v2/userctx/user/child/device/bind
语义化并不能代表全部的场景,有一些场景实际上只是增删改查,我们也对这些场景做了语义化规范,这些场景我们叫做固定化语义。
固定化语义存在基本的关键字 get
update
create
delete
truncate
, 它们之间都有存在的意义。
固定化语义 | 请求模式 | 参数形式 | 例子 | 解释 |
---|---|---|---|---|
delete | GET |
query | /apis/v2/userctx/user/child/delete | 支持删除条件 |
truncate | GET |
- |
/apis/v2/userctx/user/child/truncate | 不支持指定参数,如果需要指定条件请使用 delete 固定化语义。 |
get | GET |
query | /apis/v2/userctx/user/child/get | 支持过滤条件 |
update | POST |
body | /apis/v2/userctx/user/child/update | |
create | POST |
body | /apis/v2/userctx/user/child/create |