Rule - f-lab-edu/at_ticket GitHub Wiki

코드 컨벤션

네이버 code style 적용을 적용한다 (네이버 코드 컨벤션)
플러그인을 사용하여 코드 컨벤션을 유지한다.

API URL 규칙

1. HTTP method + 리소스(명사)를 기본으로 한다. 행위(동사)는 지양한다.

회원 리스트 조회	[GET] /users
회원 상세 조회	[GET] /users/{usersId}
회원 가입	[POST] /users
회원 정보 수정	[PATCH] /users/{usersId}
회원 탈퇴	[DELETE] /users/{usersId}

2. 리소스는 복수형으로 한다.

**회원 조회** 
- [GET] /user/{userId}   (x)
- [GET] /users/{userId}  (O)

3. HTTP method로 표현하기 어려운 경우 예외적으로 행위를 허용한다.

상품 **정보 복제**
/products/{productId}/duplicating  (x)
/products/{productId}/duplicate    (o)

4. 소문자를 사용한다.

**회원 조회** 
- [GET] /USERS/{userId}  (x)
- [GET] /users/{userId}  (O)

5. 구분자로 ‘-’을 사용한다.

[GET] /my_page (x)
[GET] /my-page (o)

⚠️ GitHub.com Fallback ⚠️