[웹 API 디자인] 10. 속성 이름은 어떻게 해야 할까?

속성 이름은 어떻게 해야 할까?

이전 섹션에서는 다양한 포맷을 지원하고 JSON을 기본 포맷으로 사용하는 것에 대해 이야기했습니다.

이번에는 응답이 돌아왔을 때 객체에 데이터 속성이 있는 경우 어떻게 속성 이름을 지정해야 하는지에 대해 이야기해 보겠습니다.

다음은 몇 가지 주요 API의 API 응답 예시입니다.

Twitter

"created_at": "Thu Nov 03 05:19;38 +0000 2011"

Bing

"DateTime": "2011-10-29T09:35:00Z"

Foursquare

"createdAt": 1320296464

각각 다른 코드 규칙을 사용합니다. Twitter 접근법은 Ruby on Rails 개발자로서 익숙하지만, Foursquare 접근법이 가장 좋다고 생각합니다.

API 응답이 코드로 어떻게 반환되나요? 응답을 구문 분석한 후(JSON parser), 반환된 결과가 객체를 채웁니다. 이것은 다음과 같습니다.

var myObject = JSON.parse(response);

Twitter 또는 Bing 접근법을 선택한 경우 코드는 다음과 같습니다. 이것은 JavaScript 규약이 아니므로 이상하게 보입니다. 시스템의 다른 객체나 클래스 이름처럼 보이며, 이것은 올바르지 않습니다.

timing = myObject.created_at;
timing - myObject.DateTime;

권장 사항:

• JSON을 기본값으로 사용하세요.
• 속성 이름에 대해 JavaScript 규칙을 따르세요.
  • 중간 대문자(카멜케이스) 사용
  • 객체 유형에 따라 대문자 또는 소문자 사용

이렇게 하면 다음과 같은 코드가 생성되며, JavaScript 개발자는 JavaScript에 맞게 작성할 수 있습니다.

"createdAt": 1320296464
timing = myObject.createdAt;