api - Java 开发 App 接口中关于 url 和入参名称规范的问题

Question

现在公司用开发给前端用的接口，语言是Java，现在想定开发规范，然后有些纠结的地方：

一个是接口的名称，之前用的的驼峰的形式，比如myTopic，但是看网上推荐的有my_topic，更容易辨识，或者推荐比较多的my-topic，看到说法是比前一种输入起来更方便。

还有个入参的问题，比如一个接口接受的参数是分页的页数，之前也是习惯性的驼峰的pageNum，但看很多公司，比如支付宝的接受参数都是page_num这种。

想问下大家以上两个问题一般用的是那种或推荐哪种？

Answer 1

会社ごとに書き方が異なり、社内のチームによっても書き方が異なります。

しかし、がほとんどの場合正しいという書き方が常にあり、それがこぶです。

キャメルケースの書き方は実験でも検証されており、最も認識しやすく、認識速度も速いです。キャメルバックの可読性に関する研究はここで読むことができます

Answer 2

個人的には、いわゆる仕様とは フロントエンドとバックエンドの合意 であり、合意が形成され、ニーズを満たすことができれば、この合意はあなたの仕様であると思います。

Answer 3

最初のもの
https://img.hacpai.com/file/2...

Answer 4

スタイルに関する質問に対する標準的な答えはありません。リストした 3 つの方法でケースが見つかります。

私は個人的に、下線メソッドの page_num を使用しています。これは、より読みやすく、小文字を使用するため、URL/URI により適しています。

Answer 5

Douban の URL デザイン http://www.prower.cn/interact... を使用することをお勧めします