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

스타일 질문에는 정해진 답이 없습니다. 나열된 세 가지 방법으로 사례를 찾을 수 있습니다.

저는 개인적으로 더 읽기 쉽고 소문자를 사용하는 밑줄 방식인 page_num을 사용합니다. 이는 url/uri에 더 적합합니다.

Answer 5

Douban의 URL 디자인 http://www.prower.cn/interact...을 사용하는 것이 좋습니다.