搜索

首页  >  问答  >  正文

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

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

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

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

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

PHP中文网PHP中文网2807 天前920

全部回复(5)我来回复

  • 伊谢尔伦

    伊谢尔伦2017-04-18 10:50:21

    各个公司都有不同的写法,甚至一个公司内不同的团队都会有不同的写法。

    但总有一种大多数时候是对的的写法,那就是驼峰。

    驼峰写法也被实验验证过,最容易让人识别,且识别速度快。可以看这里驼峰可读性的研究

    回复
    0
  • 黄舟

    黄舟2017-04-18 10:50:21

    个人觉得所谓的规范 就是你们前后端的约定,约定好了,能满足需求,那么这个约定就是你们的规范。

    回复
    0
  • ringa_lee

    ringa_lee2017-04-18 10:50:21

    第一种
    https://img.hacpai.com/file/2...

    回复
    0
  • 怪我咯

    怪我咯2017-04-18 10:50:21

    风格问题没有标准答案,你列举的3种方式都能找到案例。

    我个人用的是下划线方式 page_num这种,这种的可读性更好,都使用小写字母,比较适合url/uri。

    回复
    0
  • 高洛峰

    高洛峰2017-04-18 10:50:21

    建议采用豆瓣的URL的设计 http://www.prower.cn/interact...

    回复
    0
  • 取消回复