rest api url 규칙!

Question

안녕하세요!rest api url 규칙이 제가 알고있는게 맞는지 확인 부탁드립니다!1.admin 단일 조회 get -> /api/admin/{seq}2.admin 리스트 조회get -> /api/admins3.admin 생성post -> /api/admin4.admin 수정put -> /api/admin5.admin 삭제delete -> /api/admin/{seq}**새로운 객체가 만들어진다면 ? -> post이미 있는 객체를 수정한다면 ? -> put로그인 부분에서암호화된 패스워드는 보안 때문에 Post로 &#64;RequestBody로 받고 있습니다.이렇게 받는게 맞을까요?틀린게 있으면 지적 부탁드립니다!

페코옹 · Accepted Answer

일반적으로 사용하는 룰이 있다보니 그냥 따라하시는게 가장 좋지 않을까 합니다.spring 문서 (https://spring.io/guides/tutorials/rest/)리스트 조회 : GET -> admins단일 조회 : GET -> admins/{seq}생성 : POST -> admins수정 : PUT -> admins/{seq}삭제 : DELETE -> admins/{seq}nest 문서 (https://docs.nestjs.com/controllers)리스트 조회 : GET -> admins단일 조회 : GET -> admins/{seq}생성 : POST -> admins수정 : PUT -> admins/{seq}삭제 : DELETE -> admins/{seq}drf 문서 (https://www.django-rest-framework.org/tutorial/6-viewsets-and-routers/)리스트 조회 : GET -> admins단일 조회 : GET -> admins/{seq}생성 : POST -> admins수정 : PUT or PATCH -> admins/{seq}삭제 : DELETE -> admins/{seq}

kenu,전독시 · Answer

RESTful API를 위한 6가지 원칙과 네이밍https://prohannah.tistory.com/156참고하세요.

뎅이 · Answer

음 회사 정책에 따라 다르긴 할텐데요.보통은 보안정책 때문에 HEAD / GET / POST / OPTIONS 만 쓸 수 있습니다.

KarlStyner · Answer

전체적으로 단수/복수를 혼용하고 계신데요,get -> /api/admins/{seq}get -> /api/adminspost -> /api/adminsput -> /api/admins처럼, 같은 경로에서 전체를 보냐 특정 누군가를 보냐의 느낌으로 단수/복수를 맞춰주시는게 좋습니다.더불어, /api/ 가 공통적으로 보이고 있는데, 이는 서브도메인으로 빼는게 더 나아 보입니다.api.xxx.com/admins 처럼요그리고 put -> /api/admins 이 '한명의 관리자를 수정한다'는 의미라면, put -> /api/admins/{seq} 또는 patch -> /api/admins/{seq} 가 더 나아 보입니다.뭔가를 '생성할 때' post를 쓰느냐 put을 쓰느냐에 대한 논쟁이 있긴 한데, 개인적으로는 생성시 put, 수정 시 patch, crud와 무관할 때 post를 쓰는 것이 더 명확하게 구분되는 느낌이라 선호합니다.*엄밀히 post는 '무조건 생성', put은 '있으면 수정, 없으면 생성', patch는 '있을때만 수정' 의 의미입니다. 따라서 리소스가 있고 없고에 대한 전제가 보장될 경우 put을 생성의 의도로만 사용해도 무방하다고 생각합니다.정리해보면, 아래와 같이 씁니다.get -> /admins/{seq}-> 한명의 관리자를 가져옴get -> /admins-> 전체 관리자를 가져옴(파라미터로 범위 내지 조건 지정)put -> /admins-> 관리자 생성patch -> /admins/{seq}-> 관리자 1명의 정보를 수정post -> /admins/{seq}/push-> 특정 관리자 1명에게 푸시를 보냄'명확하게 정의되지 않은 부분'은 각자 회사에서 하기 나름이지만, 다년간의 시행착오 끝에 적어도 저와 제 주위 사람들은 저런 느낌으로 사용하고 있습니다.

rest api url 규칙!

4개의 답변

#url 목록