✨규칙✨
URL 패턴은 리소스를 식별하는데 사용한다.
- URL 패턴 작성 시 각 리소스들을 계층형으로 작성한다.
ex) members/{seq} : seq에 맞는 멤버 정보 조회
members/{seq}/nickname : seq 에 맞는 멤버의 닉네임 조회
- URL 패턴 작성 시 전부 명사로 작성한다. (명사로 표현할 수 없는 API일 때는 동사로 작성한다)
Method는 해당 리소스로 어떤 작업을 할 것인지를 표현한다.
- GET : 조회
- POST : 저장
- PUT : 수정
- DELETE : 삭제
MethodName은 컨트롤러에서 실제 구현 시 사용되는 메서드 이름이다.
- 리스트는 xxxList()가 아니라 xxxs()처럼 단어의 복수형으로 작성한다.
- 메서드는 무슨 역할을 하는지 명확하게 알 수 있도록 작성한다. 항상 첫 단어는 동사로 시작한다.
- CRUD의 경우 다음 컨벤션을 활용한다.
- add : 저장
- get : 조회
- modify : 수정
- delete : 삭제
- 메소드 오버로딩을 사용해 메서드 이름을 간결하게 만들고 파라미터로 작업을 식별한다.
협의사항(스크럼) : <https://www.notion.so/0913-3ced1c1c9dee48cdac35d46967dbe359#58d0e5850c86477f901c50083770b6ef>
Member
Untitled
Music
Untitled
Box
Untitled
NFT
Untitled
Reward
Untitled
File
Untitled
기능 명세서