作者chan15 (ChaN)
看板Web_Design
标题[问题] RESTful API 非 resource 的设计问题
时间Fri Sep 1 00:04:55 2023
各位好，目前我使用 Laravel 当作 API Server 的开发，爬过很多关於 RESTful 的文章
，如果是 resource 确定的 crud 很容易处理，举例来说如果是使用者 > 文章 > 留言
controller name
UserArticleCommentController.php
网址会是 GET www.example.com/users/{user_id}/articles/{article_id}/comments
但常常会有规格外的东西就会比较苦恼，我知道这没有一定自己公司说好就可以遵守，但
还是想听听看有相关经验的朋友可以提供一下想法，下面开始举例。
场景一，建立 widget：
我今天要提供前端三只 API 资料给前端的 widget 用，像是 login-records、votes、
stars，这三个名称以及 widget 都没有所谓的 resource 概念，每一只都是多张表整理出
来的结果，那档案跟网址命名该怎麽做才好。
1.1
WidgetController.php
function getLoginRecord()
function getVotes()
function getStars
1.2
WidgetLoginRecordController.php
function index()
WidgetVoteController.php
function index()
WidgetStarController.php
function index()
1.3
Widget/LoginRecordController.php
function index()
Widget/VoteController.php
function index()
Widget/StartController.php
function index()
如果以跟一般 RESTful resource 安排一样的话，会是 1.2，但这只 API 理论上都只有
index 这个 method，这样是否有点浪费资源。
另外是 url 应该用 widgets/login-records 还是 widget/login-records，widget 有多
只，但实际上他们不是像 users/{user_id} 这种从多个 users data 里面抽出某一笔的概
念。
场景二：复合式动作的命名
假设要订阅某个文章，他是拿 header 里的 token 找出 user，然後带入文章 id 後写入
pivot table 那该怎麽命名。
2.1
ArticleController.php
function subscribe()
POST www.example.com/articles/{article_id}/subscription
还是应该更明确
2.2
ArticleController.php
function userSubscribe()
POST www.example.com/articles/{article_id}/user-subscription
场景三：特殊注况
以使用者密码为例，密码可能有重设密码、忘记密码
3.1
UserPasswordController.php
function reset()
users/password/reset
function forgot()
users/password/forgot
3.2
UserController.php
function resetPassword()
users/password-reset
function forgotPassword()
users/password-forgot
想请教各位会怎麽选择。
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 122.116.234.173 (台湾)
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Web_Design/M.1693497897.A.57C.html
※ 编辑: chan15 (122.116.234.173 台湾), 09/01/2023 00:06:28
2F：→ single4565: ons/3077229/restful-password-reset 09/01 02:46
3F：推 ian90911: 也看过动词用冒号接的方式 如user:resetpwd 09/01 11:15
4F：→ vi000246: 去读clean code 或重构相关的书 09/01 11:23
5F：→ ssccg: 浪费是什麽意思? 档案多并不会浪费什麽资源啊 09/02 21:10
6F：→ ssccg: 第二个除非subscription有很多种不然没差吧 09/02 21:13
7F：→ ssccg: 第三个看不懂你的forgot跟reset是差在哪，忘记密码是使用者 09/02 21:14
8F：→ ssccg: 状态不是系统要做的动作吧。当然你问只可能只是动词要怎麽 09/02 21:15
9F：→ ssccg: 办，个人会先考虑能不能PUT凑上去就够用 09/02 21:16
10F：推 youtuuube000: 其实不用太纠结 restful resource的想法 有些操作本 04/23 14:13
11F：→ youtuuube000: 来就很难抽象化成资源 直接用动词就好 04/23 14:13