接口地址命名如何规范

Question

接口地址的命名规范如何比较好呢？
{{host}}/admin_user/user_lst
{{host}}/adminUser/userLst
哪种比较好呢？

还有传参和返回参数 是用驼峰好还是下划线好呢

根据psr规范 变量命名是驼峰法

return [
adminUser=>'xxx',
adminLst = '',
];

这种是下划线
return [
admin_user=>'xxx',
admin_lst = '',
];

Answer 1

1、路由应该使用 短划线(-) 来代替下划线(_)。
2、应该避免使用大写，驼峰的形式
3、应当尽量避免动词语法，尽可能按照 RESTful 进行设计。
4、传递参数、响应参数尽量选择使用下划线而不是驼峰。

PSR 规定的是 PHP 代码编写规范，API 开发规范是另外一回事儿，如果你使用类似于 TP3 那样的自动路由，就很容易出现这种驼峰式的代码，推荐使用自定义路由。

Answer 2

常规来讲 url 不区分大小写，基本默认是全小写
所以 驼峰命名 不太合适
除了 _ , url 可以用 - 视觉感受更好些
admin_user 和 admin-user

如果有 URL 到变量名/类名/命名空间 转换的话，用 - 要做一次替换