(TIL) 2024-12-02

API 설계 Rules

---

오늘 과제를 진행하면서 RESTFUL API에서 구성요소 중 URI부분의 URL을 고민하던 중 어떠한 룰이 있는지 찾아보았다.

• 자원(Resource) - URI : 해당 소프트웨어가 관리하는 모든 것 ( 문서, 그림, 데이터, 해당 소프트웨어 자체 등 )

1. 소문자를 사용한다
   X /api/USERS
   O /api/users

2. 복수 > 단수
   인터넷에 찾아보면 단수를 쓰면 안된다. 된다. 여러가지 글이 존재한다. 일단 찾아본 결론은 실무에서는 단수를 쓰는 곳이 존재한다. 그러나 혼합해서 사용하는 경우는 지양한다고 한다. 하나로 통일해서 사용하는게 보편적인 것 같다.

3. 언더바(_) 대신 하이픈(-)을 사용한다
   X /api/user_info
   O /api/users-info

4. 마지막에 슬래시(/)를 포함하지 않는다
   X /api/user_info/
   O /api/users-info

5. 행위를 포함하지 않는다.
   X /api/getuser/
   X /api/user/delete
   O /api/user/

6. 전달하고자 하는 명사를 사용한다. (단 컨트롤 자원을 의미하는 경우 예외적으로 동사를 사용)
   X /api/user/
   O /apu/user/

7. 파일 확장자는 URL에 포함시키지 않는다.
   X /api/user/photo.jpg
   O /api/user/photo

내가 참 못하는게 이름 짓는거 인데 (파일명,변수명 등등) 여기에 URL까지 들어가버리니 머리가 터질 것 같다.