본문 바로가기
  • 분조장의 개발 블로그
GraphQL

GraphQL 명명 Convention

by 무아니 2021. 5. 17.

GraphQL이 특정 명명 지침을 지정하진 않았지만 Apollo-server에서 일관성을 위해 권장하는 명명규칙이 있다.

이런 규칙을 사용하면 대부분의 클라이언트가 서버에서 반환되는 결과를 변환하기 위해 추가 로직을 정의할 필요가 없다고한다!

링크 > Apollo-server Doc 참고

 

자료형 명명규칙

필드 - 이름 camelCase
형식 - 이름
PascalCase
열거형 - 이름 PascalCase
열거형 - 값 ALL_CAPS(모두 대문자)

예시

# 필드 이름: addBook (camelCase)
# 형식 이름: String, Book (PascalCase)
type Mutation {
  addBook(title: String, author: String): Book
}

# 열거형 이름: AllowedColor (PascalCase)
# 열거형 값: RED, GREEN, BLUE (ALL_CAPS)
enum AllowedColor {
  RED
  GREEN
  BLUE
}

 

댓글