-
Notifications
You must be signed in to change notification settings - Fork 13.1k
Closed
Labels
contribution welcomekind/code qualitykind/discussionCategory issues related to discussionCategory issues related to discussion
Description
整体规范
以用户为例,/users 代表整体资源,/users/{id} 代表单个资源,若以其他条件查询则为 /users?name={name}&age={age}。其中id为数据库定义的无意义主键,任何有意义的字段均以条件查询的方式传入。若无数据库实体,亦使用条件查询方式
GET请求获取全部资源时 /users,按 ID 获取资源为 /users/{id},按条件查询 /users?name={name}。其中 ID 接口返回值为单个实体,其余均为 LIST
POST仅用于创建资源,接口为 /users,接口返回值为成功或失败
PUT用于更新资源,必须带有参数,以 ID 更新则为 /users/{id},以名字更新则为 /users?name={name},需要更新的数据均在 RequestBody 中,接口返回值为成功或失败
DELETE用于删除资源,也必须带有参数,参数事例与PUT相同,但是没有RequestBody,接口返回值为成功或失败
其他个性化接口不需符合上述定义,如 CoreOpsController 中的 raftOps 接口
带参数的接口需要声明所需的参数,不是必要的参数则 required 设为 false,勿定义入参不同的重复接口。参数为 NULL 时代表不使用该参数,不能所有参数同时为 NULL。同时分页参数均以 pageNo 和 pageSize 的形式以条件查询的方式传入
更新资源时若 RequestBody 中有字段为 NULL,则不更新该字段。若为空字符串,则依然更新,前端调用时需进行控制。
欢迎补充或提供意见
lpaz010, onewe and realJackSun
Metadata
Metadata
Assignees
Labels
contribution welcomekind/code qualitykind/discussionCategory issues related to discussionCategory issues related to discussion